All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.filestore.kotlin.Backup.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.filestore.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map

/**
 * Builder for [Backup].
 */
@PulumiTagMarker
public class BackupResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: BackupArgs = BackupArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend BackupArgsBuilder.() -> Unit) {
        val builder = BackupArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): Backup {
        val builtJavaResource = com.pulumi.gcp.filestore.Backup(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Backup(builtJavaResource)
    }
}

/**
 * A Google Cloud Filestore backup.
 * To get more information about Backup, see:
 * * [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.backups)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/filestore/docs/backups)
 *     * [Creating Backups](https://cloud.google.com/filestore/docs/create-backups)
 * ## Example Usage
 * ### Filestore Backup Basic
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const instance = new gcp.filestore.Instance("instance", {
 *     name: "tf-fs-inst",
 *     location: "us-central1-b",
 *     tier: "BASIC_HDD",
 *     fileShares: {
 *         capacityGb: 1024,
 *         name: "share1",
 *     },
 *     networks: [{
 *         network: "default",
 *         modes: ["MODE_IPV4"],
 *         connectMode: "DIRECT_PEERING",
 *     }],
 * });
 * const backup = new gcp.filestore.Backup("backup", {
 *     name: "tf-fs-bkup",
 *     location: "us-central1",
 *     description: "This is a filestore backup for the test instance",
 *     sourceInstance: instance.id,
 *     sourceFileShare: "share1",
 *     labels: {
 *         files: "label1",
 *         "other-label": "label2",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * instance = gcp.filestore.Instance("instance",
 *     name="tf-fs-inst",
 *     location="us-central1-b",
 *     tier="BASIC_HDD",
 *     file_shares=gcp.filestore.InstanceFileSharesArgs(
 *         capacity_gb=1024,
 *         name="share1",
 *     ),
 *     networks=[gcp.filestore.InstanceNetworkArgs(
 *         network="default",
 *         modes=["MODE_IPV4"],
 *         connect_mode="DIRECT_PEERING",
 *     )])
 * backup = gcp.filestore.Backup("backup",
 *     name="tf-fs-bkup",
 *     location="us-central1",
 *     description="This is a filestore backup for the test instance",
 *     source_instance=instance.id,
 *     source_file_share="share1",
 *     labels={
 *         "files": "label1",
 *         "other-label": "label2",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var instance = new Gcp.Filestore.Instance("instance", new()
 *     {
 *         Name = "tf-fs-inst",
 *         Location = "us-central1-b",
 *         Tier = "BASIC_HDD",
 *         FileShares = new Gcp.Filestore.Inputs.InstanceFileSharesArgs
 *         {
 *             CapacityGb = 1024,
 *             Name = "share1",
 *         },
 *         Networks = new[]
 *         {
 *             new Gcp.Filestore.Inputs.InstanceNetworkArgs
 *             {
 *                 Network = "default",
 *                 Modes = new[]
 *                 {
 *                     "MODE_IPV4",
 *                 },
 *                 ConnectMode = "DIRECT_PEERING",
 *             },
 *         },
 *     });
 *     var backup = new Gcp.Filestore.Backup("backup", new()
 *     {
 *         Name = "tf-fs-bkup",
 *         Location = "us-central1",
 *         Description = "This is a filestore backup for the test instance",
 *         SourceInstance = instance.Id,
 *         SourceFileShare = "share1",
 *         Labels =
 *         {
 *             { "files", "label1" },
 *             { "other-label", "label2" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{
 * 			Name:     pulumi.String("tf-fs-inst"),
 * 			Location: pulumi.String("us-central1-b"),
 * 			Tier:     pulumi.String("BASIC_HDD"),
 * 			FileShares: &filestore.InstanceFileSharesArgs{
 * 				CapacityGb: pulumi.Int(1024),
 * 				Name:       pulumi.String("share1"),
 * 			},
 * 			Networks: filestore.InstanceNetworkArray{
 * 				&filestore.InstanceNetworkArgs{
 * 					Network: pulumi.String("default"),
 * 					Modes: pulumi.StringArray{
 * 						pulumi.String("MODE_IPV4"),
 * 					},
 * 					ConnectMode: pulumi.String("DIRECT_PEERING"),
 * 				},
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = filestore.NewBackup(ctx, "backup", &filestore.BackupArgs{
 * 			Name:            pulumi.String("tf-fs-bkup"),
 * 			Location:        pulumi.String("us-central1"),
 * 			Description:     pulumi.String("This is a filestore backup for the test instance"),
 * 			SourceInstance:  instance.ID(),
 * 			SourceFileShare: pulumi.String("share1"),
 * 			Labels: pulumi.StringMap{
 * 				"files":       pulumi.String("label1"),
 * 				"other-label": pulumi.String("label2"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.gcp.filestore.Instance;
 * import com.pulumi.gcp.filestore.InstanceArgs;
 * import com.pulumi.gcp.filestore.inputs.InstanceFileSharesArgs;
 * import com.pulumi.gcp.filestore.inputs.InstanceNetworkArgs;
 * import com.pulumi.gcp.filestore.Backup;
 * import com.pulumi.gcp.filestore.BackupArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var instance = new Instance("instance", InstanceArgs.builder()
 *             .name("tf-fs-inst")
 *             .location("us-central1-b")
 *             .tier("BASIC_HDD")
 *             .fileShares(InstanceFileSharesArgs.builder()
 *                 .capacityGb(1024)
 *                 .name("share1")
 *                 .build())
 *             .networks(InstanceNetworkArgs.builder()
 *                 .network("default")
 *                 .modes("MODE_IPV4")
 *                 .connectMode("DIRECT_PEERING")
 *                 .build())
 *             .build());
 *         var backup = new Backup("backup", BackupArgs.builder()
 *             .name("tf-fs-bkup")
 *             .location("us-central1")
 *             .description("This is a filestore backup for the test instance")
 *             .sourceInstance(instance.id())
 *             .sourceFileShare("share1")
 *             .labels(Map.ofEntries(
 *                 Map.entry("files", "label1"),
 *                 Map.entry("other-label", "label2")
 *             ))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:filestore:Instance
 *     properties:
 *       name: tf-fs-inst
 *       location: us-central1-b
 *       tier: BASIC_HDD
 *       fileShares:
 *         capacityGb: 1024
 *         name: share1
 *       networks:
 *         - network: default
 *           modes:
 *             - MODE_IPV4
 *           connectMode: DIRECT_PEERING
 *   backup:
 *     type: gcp:filestore:Backup
 *     properties:
 *       name: tf-fs-bkup
 *       location: us-central1
 *       description: This is a filestore backup for the test instance
 *       sourceInstance: ${instance.id}
 *       sourceFileShare: share1
 *       labels:
 *         files: label1
 *         other-label: label2
 * ```
 * 
 * ## Import
 * Backup can be imported using any of these accepted formats:
 * * `projects/{{project}}/locations/{{location}}/backups/{{name}}`
 * * `{{project}}/{{location}}/{{name}}`
 * * `{{location}}/{{name}}`
 * When using the `pulumi import` command, Backup can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:filestore/backup:Backup default projects/{{project}}/locations/{{location}}/backups/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:filestore/backup:Backup default {{project}}/{{location}}/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:filestore/backup:Backup default {{location}}/{{name}}
 * ```
 */
public class Backup internal constructor(
    override val javaResource: com.pulumi.gcp.filestore.Backup,
) : KotlinCustomResource(javaResource, BackupMapper) {
    /**
     * The amount of bytes needed to allocate a full copy of the snapshot content.
     */
    public val capacityGb: Output
        get() = javaResource.capacityGb().applyValue({ args0 -> args0 })

    /**
     * The time when the snapshot was created in RFC3339 text format.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Amount of bytes that will be downloaded if the backup is restored.
     */
    public val downloadBytes: Output
        get() = javaResource.downloadBytes().applyValue({ args0 -> args0 })

    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    public val effectiveLabels: Output>
        get() = javaResource.effectiveLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * KMS key name used for data encryption.
     */
    public val kmsKeyName: Output
        get() = javaResource.kmsKeyName().applyValue({ args0 -> args0 })

    /**
     * Resource labels to represent user-provided metadata.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effective_labels` for all of the labels present on the resource.
     */
    public val labels: Output>?
        get() = javaResource.labels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The name of the location of the instance. This can be a region for ENTERPRISE tier instances.
     * - - -
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * The resource name of the backup. The name must be unique within the specified instance.
     * The name must be 1-63 characters long, and comply with
     * RFC1035. Specifically, the name must be 1-63 characters long and match
     * the regular expression `a-z?` which means the
     * first character must be a lowercase letter, and all following
     * characters must be a dash, lowercase letter, or digit, except the last
     * character, which cannot be a dash.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    public val pulumiLabels: Output>
        get() = javaResource.pulumiLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * Name of the file share in the source Cloud Filestore instance that the backup is created from.
     */
    public val sourceFileShare: Output
        get() = javaResource.sourceFileShare().applyValue({ args0 -> args0 })

    /**
     * The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup.
     */
    public val sourceInstance: Output
        get() = javaResource.sourceInstance().applyValue({ args0 -> args0 })

    /**
     * The service tier of the source Cloud Filestore instance that this backup is created from.
     */
    public val sourceInstanceTier: Output
        get() = javaResource.sourceInstanceTier().applyValue({ args0 -> args0 })

    /**
     * The backup state.
     */
    public val state: Output
        get() = javaResource.state().applyValue({ args0 -> args0 })

    /**
     * The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
     */
    public val storageBytes: Output
        get() = javaResource.storageBytes().applyValue({ args0 -> args0 })
}

public object BackupMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.filestore.Backup::class == javaResource::class

    override fun map(javaResource: Resource): Backup = Backup(
        javaResource as
            com.pulumi.gcp.filestore.Backup,
    )
}

/**
 * @see [Backup].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Backup].
 */
public suspend fun backup(name: String, block: suspend BackupResourceBuilder.() -> Unit): Backup {
    val builder = BackupResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Backup].
 * @param name The _unique_ name of the resulting resource.
 */
public fun backup(name: String): Backup {
    val builder = BackupResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy