Package com.hashicorp.cdktf.providers.google.alloydb_cluster

Interface AlloydbClusterAutomatedBackupPolicy

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

    • Method Detail

      • getBackupWindow

        @Stability(Stable)
@Nullable
default String getBackupWindow()
        The length of the time window during which a backup can be taken.

        If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it will default to 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#backup_window AlloydbCluster#backup_window}

      • getEnabled

        @Stability(Stable)
@Nullable
default Object getEnabled()
        Whether automated backups are enabled.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#enabled AlloydbCluster#enabled}

      • getEncryptionConfig

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

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

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        Labels to apply to backups created using this configuration.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#labels AlloydbCluster#labels}

      • getLocation

        @Stability(Stable)
@Nullable
default String getLocation()
        The location where the backup will be stored.

        Currently, the only supported option is to store the backup in the same region as the cluster. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#location AlloydbCluster#location}

      • getQuantityBasedRetention

        @Stability(Stable)
@Nullable
default AlloydbClusterAutomatedBackupPolicyQuantityBasedRetention getQuantityBasedRetention()
        quantity_based_retention block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#quantity_based_retention AlloydbCluster#quantity_based_retention}

      • getTimeBasedRetention

        @Stability(Stable)
@Nullable
default AlloydbClusterAutomatedBackupPolicyTimeBasedRetention getTimeBasedRetention()
        time_based_retention block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#time_based_retention AlloydbCluster#time_based_retention}

      • getWeeklySchedule

        @Stability(Stable)
@Nullable
default AlloydbClusterAutomatedBackupPolicyWeeklySchedule getWeeklySchedule()
        weekly_schedule block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#weekly_schedule AlloydbCluster#weekly_schedule}