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

Interface FilestoreBackupConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    FilestoreBackupConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.186Z")
@Stability(Stable)
public interface FilestoreBackupConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        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}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getSourceFileShare

        @Stability(Stable)
@NotNull
String getSourceFileShare()
        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}

      • getSourceInstance

        @Stability(Stable)
@NotNull
String getSourceInstance()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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}

      • getProject

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

      • getTimeouts

        @Stability(Stable)
@Nullable
default FilestoreBackupTimeouts getTimeouts()
        timeouts block.

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