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

Class AlloydbClusterConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • clusterId

        @Stability(Stable)
public AlloydbClusterConfig.Builder clusterId​(String clusterId)
        Sets the value of AlloydbClusterConfig.getClusterId()
        Parameters:
        clusterId - The ID of the alloydb cluster. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#cluster_id AlloydbCluster#cluster_id}
        Returns:
        this

      • location

        @Stability(Stable)
public AlloydbClusterConfig.Builder location​(String location)
        Sets the value of AlloydbClusterConfig.getLocation()
        Parameters:
        location - The location where the alloydb cluster should reside. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#location AlloydbCluster#location}
        Returns:
        this

      • annotations

        @Stability(Stable)
public AlloydbClusterConfig.Builder annotations​(Map<String,​String> annotations)
        Sets the value of AlloydbClusterConfig.getAnnotations()
        Parameters:
        annotations - 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}
        Returns:
        this

      • clusterType

        @Stability(Stable)
public AlloydbClusterConfig.Builder clusterType​(String clusterType)
        Sets the value of AlloydbClusterConfig.getClusterType()
        Parameters:
        clusterType - 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}
        Returns:
        this

      • databaseVersion

        @Stability(Stable)
public AlloydbClusterConfig.Builder databaseVersion​(String databaseVersion)
        Sets the value of AlloydbClusterConfig.getDatabaseVersion()
        Parameters:
        databaseVersion - 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}
        Returns:
        this

      • deletionPolicy

        @Stability(Stable)
public AlloydbClusterConfig.Builder deletionPolicy​(String deletionPolicy)
        Sets the value of AlloydbClusterConfig.getDeletionPolicy()
        Parameters:
        deletionPolicy - 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}
        Returns:
        this

      • displayName

        @Stability(Stable)
public AlloydbClusterConfig.Builder displayName​(String displayName)
        Sets the value of AlloydbClusterConfig.getDisplayName()
        Parameters:
        displayName - 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}
        Returns:
        this

      • etag

        @Stability(Stable)
public AlloydbClusterConfig.Builder etag​(String etag)
        Sets the value of AlloydbClusterConfig.getEtag()
        Parameters:
        etag - 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}
        Returns:
        this

      • id

        @Stability(Stable)
public AlloydbClusterConfig.Builder id​(String id)
        Sets the value of AlloydbClusterConfig.getId()
        Parameters:
        id - 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.
        Returns:
        this

      • labels

        @Stability(Stable)
public AlloydbClusterConfig.Builder labels​(Map<String,​String> labels)
        Sets the value of AlloydbClusterConfig.getLabels()
        Parameters:
        labels - 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}
        Returns:
        this

      • network

        @Stability(Stable)
public AlloydbClusterConfig.Builder network​(String network)
        Sets the value of AlloydbClusterConfig.getNetwork()
        Parameters:
        network - 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}
        Returns:
        this

      • project

        @Stability(Stable)
public AlloydbClusterConfig.Builder project​(String project)
        Sets the value of AlloydbClusterConfig.getProject()
        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster#project AlloydbCluster#project}.
        Returns:
        this

      • connection

        @Stability(Experimental)
public AlloydbClusterConfig.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • connection

        @Stability(Experimental)
public AlloydbClusterConfig.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Sets the value of TerraformMetaArguments.getConnection()
        Parameters:
        connection - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public AlloydbClusterConfig.Builder count​(Number count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • count

        @Stability(Experimental)
public AlloydbClusterConfig.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Sets the value of TerraformMetaArguments.getCount()
        Parameters:
        count - the value to be set.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public AlloydbClusterConfig.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Sets the value of TerraformMetaArguments.getDependsOn()
        Parameters:
        dependsOn - the value to be set.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public AlloydbClusterConfig.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Sets the value of TerraformMetaArguments.getForEach()
        Parameters:
        forEach - the value to be set.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public AlloydbClusterConfig.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Sets the value of TerraformMetaArguments.getLifecycle()
        Parameters:
        lifecycle - the value to be set.
        Returns:
        this

      • provider

        @Stability(Experimental)
public AlloydbClusterConfig.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Sets the value of TerraformMetaArguments.getProvider()
        Parameters:
        provider - the value to be set.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public AlloydbClusterConfig.Builder provisioners​(List<? extends Object> provisioners)
        Sets the value of TerraformMetaArguments.getProvisioners()
        Parameters:
        provisioners - the value to be set.
        Returns:
        this