Package com.hashicorp.cdktf.providers.google.alloydb_backup

Interface AlloydbBackupConfig

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

    • Method Detail

      • getBackupId

        @Stability(Stable)
@NotNull
String getBackupId()
        The ID of the alloydb backup.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#backup_id AlloydbBackup#backup_id}

      • getClusterName

        @Stability(Stable)
@NotNull
String getClusterName()
        The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#cluster_name AlloydbBackup#cluster_name}

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        The location where the alloydb backup should reside.

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

      • getAnnotations

        @Stability(Stable)
@Nullable
default Map<String,​String> getAnnotations()
        Annotations to allow client tools to store small amount of arbitrary data.

        This is distinct from labels. https://google.aip.dev/128 An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#annotations AlloydbBackup#annotations}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        User-provided description of the backup.

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

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        User-settable and human-readable display name for the Backup.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#display_name AlloydbBackup#display_name}

      • getEncryptionConfig

        @Stability(Stable)
@Nullable
default AlloydbBackupEncryptionConfig getEncryptionConfig()
        encryption_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#encryption_config AlloydbBackup#encryption_config}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#id AlloydbBackup#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()
        User-defined labels for the alloydb backup.

        An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **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/alloydb_backup#labels AlloydbBackup#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/alloydb_backup#project AlloydbBackup#project}.

      • getTimeouts

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

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

      • getType

        @Stability(Stable)
@Nullable
default String getType()
        The backup type, which suggests the trigger for the backup. Possible values: ["TYPE_UNSPECIFIED", "ON_DEMAND", "AUTOMATED", "CONTINUOUS"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_backup#type AlloydbBackup#type}