Package com.hashicorp.cdktf.providers.google.filestore_backup

Class FilestoreBackup.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static FilestoreBackup.Builder create​(software.constructs.Construct scope,
                                             String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of FilestoreBackup.Builder.

      • connection

        @Stability(Experimental)
public FilestoreBackup.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public FilestoreBackup.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FilestoreBackup.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public FilestoreBackup.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public FilestoreBackup.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public FilestoreBackup.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public FilestoreBackup.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public FilestoreBackup.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public FilestoreBackup.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public FilestoreBackup.Builder location​(String location)
        The name of the location of the instance. This can be a region for ENTERPRISE tier instances.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#location FilestoreBackup#location}

        Parameters:
        location - The name of the location of the instance. This can be a region for ENTERPRISE tier instances. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public FilestoreBackup.Builder name​(String name)
        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](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#name FilestoreBackup#name}

        Parameters:
        name - The resource name of the backup. The name must be unique within the specified instance. This parameter is required.
        Returns:
        this

      • sourceFileShare

        @Stability(Stable)
public FilestoreBackup.Builder sourceFileShare​(String sourceFileShare)
        Name of the file share in the source Cloud Filestore instance that the backup is created from.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#source_file_share FilestoreBackup#source_file_share}

        Parameters:
        sourceFileShare - Name of the file share in the source Cloud Filestore instance that the backup is created from. This parameter is required.
        Returns:
        this

      • sourceInstance

        @Stability(Stable)
public FilestoreBackup.Builder sourceInstance​(String sourceInstance)
        The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#source_instance FilestoreBackup#source_instance}

        Parameters:
        sourceInstance - The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public FilestoreBackup.Builder description​(String description)
        A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#description FilestoreBackup#description}

        Parameters:
        description - A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public FilestoreBackup.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#id FilestoreBackup#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#id FilestoreBackup#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public FilestoreBackup.Builder labels​(Map<String,​String> labels)
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#labels FilestoreBackup#labels}

        Parameters:
        labels - Resource labels to represent user-provided metadata. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public FilestoreBackup.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#project FilestoreBackup#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#project FilestoreBackup#project}. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public FilestoreBackup.Builder timeouts​(FilestoreBackupTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/filestore_backup#timeouts FilestoreBackup#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this