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

Interface AlloydbClusterConfig

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

    • Method Detail

      • getClusterId

        @Stability(Stable)
@NotNull
String getClusterId()
        The ID of the alloydb cluster.

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

      • getLocation

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

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#location AlloydbCluster#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_cluster#annotations AlloydbCluster#annotations}

      • getAutomatedBackupPolicy

        @Stability(Stable)
@Nullable
default AlloydbClusterAutomatedBackupPolicy getAutomatedBackupPolicy()
        automated_backup_policy block.

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

      • getClusterType

        @Stability(Stable)
@Nullable
default String getClusterType()
        The type of cluster. If not set, defaults to PRIMARY. Default value: "PRIMARY" Possible values: ["PRIMARY", "SECONDARY"].

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

      • getContinuousBackupConfig

        @Stability(Stable)
@Nullable
default AlloydbClusterContinuousBackupConfig getContinuousBackupConfig()
        continuous_backup_config block.

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

      • getDatabaseVersion

        @Stability(Stable)
@Nullable
default String getDatabaseVersion()
        The database engine major version.

        This is an optional field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#database_version AlloydbCluster#database_version}

      • getDeletionPolicy

        @Stability(Stable)
@Nullable
default String getDeletionPolicy()
        Policy to determine if the cluster should be deleted forcefully.

        Deleting a cluster forcefully, deletes the cluster and all its associated instances within the cluster. Deleting a Secondary cluster with a secondary instance REQUIRES setting deletion_policy = "FORCE" otherwise an error is returned. This is needed as there is no support to delete just the secondary instance, and the only way to delete secondary instance is to delete the associated secondary cluster forcefully which also deletes the secondary instance. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#deletion_policy AlloydbCluster#deletion_policy}

      • getDisplayName

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

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

      • getEncryptionConfig

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

      • getEtag

        @Stability(Stable)
@Nullable
default String getEtag()
        For Resource freshness validation (https://google.aip.dev/154).

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

      • 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_cluster#id AlloydbCluster#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.

      • getInitialUser

        @Stability(Stable)
@Nullable
default AlloydbClusterInitialUser getInitialUser()
        initial_user block.

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

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        User-defined labels for the alloydb cluster.

        **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_cluster#labels AlloydbCluster#labels}

      • getMaintenanceUpdatePolicy

        @Stability(Stable)
@Nullable
default AlloydbClusterMaintenanceUpdatePolicy getMaintenanceUpdatePolicy()
        maintenance_update_policy block.

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

      • getNetwork

        @Stability(Stable)
@Nullable
default String getNetwork()
        The relative resource name of the VPC network on which the instance can be accessed.

        It is specified in the following form: "projects/{projectNumber}/global/networks/{network_id}". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#network AlloydbCluster#network}

      • getNetworkConfig

        @Stability(Stable)
@Nullable
default AlloydbClusterNetworkConfig getNetworkConfig()
        network_config block.

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

      • 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_cluster#project AlloydbCluster#project}.

      • getPscConfig

        @Stability(Stable)
@Nullable
default AlloydbClusterPscConfig getPscConfig()
        psc_config block.

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

      • getRestoreBackupSource

        @Stability(Stable)
@Nullable
default AlloydbClusterRestoreBackupSource getRestoreBackupSource()
        restore_backup_source block.

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

      • getRestoreContinuousBackupSource

        @Stability(Stable)
@Nullable
default AlloydbClusterRestoreContinuousBackupSource getRestoreContinuousBackupSource()
        restore_continuous_backup_source block.

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

      • getSecondaryConfig

        @Stability(Stable)
@Nullable
default AlloydbClusterSecondaryConfig getSecondaryConfig()
        secondary_config block.

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

      • getTimeouts

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

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