Package com.hashicorp.cdktf.providers.google.alloydb_instance

Class AlloydbInstance.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static AlloydbInstance.Builder create​(software.constructs.Construct scope,
                                             String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of AlloydbInstance.Builder.

      • connection

        @Stability(Experimental)
public AlloydbInstance.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public AlloydbInstance.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public AlloydbInstance.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public AlloydbInstance.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public AlloydbInstance.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public AlloydbInstance.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public AlloydbInstance.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public AlloydbInstance.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public AlloydbInstance.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • cluster

        @Stability(Stable)
public AlloydbInstance.Builder cluster​(String cluster)
        Identifies the alloydb cluster. Must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#cluster AlloydbInstance#cluster}

        Parameters:
        cluster - Identifies the alloydb cluster. Must be in the format 'projects/{project}/locations/{location}/clusters/{cluster_id}'. This parameter is required.
        Returns:
        this

      • instanceId

        @Stability(Stable)
public AlloydbInstance.Builder instanceId​(String instanceId)
        The ID of the alloydb instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#instance_id AlloydbInstance#instance_id}

        Parameters:
        instanceId - The ID of the alloydb instance. This parameter is required.
        Returns:
        this

      • instanceType

        @Stability(Stable)
public AlloydbInstance.Builder instanceType​(String instanceType)
        The type of the instance.

        If the instance type is READ_POOL, provide the associated PRIMARY/SECONDARY instance in the 'depends_on' meta-data attribute. If the instance type is SECONDARY, point to the cluster_type of the associated secondary cluster instead of mentioning SECONDARY. Example: {instance_type = google_alloydb_cluster..cluster_type} instead of {instance_type = SECONDARY} If the instance type is SECONDARY, the terraform delete instance operation does not delete the secondary instance but abandons it instead. Use deletion_policy = "FORCE" in the associated secondary cluster and delete the cluster forcefully to delete the secondary cluster as well its associated secondary instance. Users can undo the delete secondary instance action by importing the deleted secondary instance by calling terraform import. Possible values: ["PRIMARY", "READ_POOL", "SECONDARY"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#instance_type AlloydbInstance#instance_type}

        Parameters:
        instanceType - The type of the instance. This parameter is required.
        Returns:
        this

      • annotations

        @Stability(Stable)
public AlloydbInstance.Builder annotations​(Map<String,​String> annotations)
        Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels.

        **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_instance#annotations AlloydbInstance#annotations}

        Parameters:
        annotations - Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. This parameter is required.
        Returns:
        this

      • availabilityType

        @Stability(Stable)
public AlloydbInstance.Builder availabilityType​(String availabilityType)
        'Availability type of an Instance.

        Defaults to REGIONAL for both primary and read instances. Note that primary and read instances can have different availability types. Only READ_POOL instance supports ZONAL type. Users can't specify the zone for READ_POOL instance. Zone is automatically chosen from the list of zones in the region specified. Read pool of size 1 can only have zonal availability. Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).' Possible values: ["AVAILABILITY_TYPE_UNSPECIFIED", "ZONAL", "REGIONAL"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#availability_type AlloydbInstance#availability_type}

        Parameters:
        availabilityType - 'Availability type of an Instance. This parameter is required.
        Returns:
        this

      • clientConnectionConfig

        @Stability(Stable)
public AlloydbInstance.Builder clientConnectionConfig​(AlloydbInstanceClientConnectionConfig clientConnectionConfig)
        client_connection_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#client_connection_config AlloydbInstance#client_connection_config}

        Parameters:
        clientConnectionConfig - client_connection_config block. This parameter is required.
        Returns:
        this

      • databaseFlags

        @Stability(Stable)
public AlloydbInstance.Builder databaseFlags​(Map<String,​String> databaseFlags)
        Database flags.

        Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#database_flags AlloydbInstance#database_flags}

        Parameters:
        databaseFlags - Database flags. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public AlloydbInstance.Builder displayName​(String displayName)
        User-settable and human-readable display name for the Instance.

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

        Parameters:
        displayName - User-settable and human-readable display name for the Instance. This parameter is required.
        Returns:
        this

      • gceZone

        @Stability(Stable)
public AlloydbInstance.Builder gceZone​(String gceZone)
        The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#gce_zone AlloydbInstance#gce_zone}

        Parameters:
        gceZone - The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public AlloydbInstance.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#id AlloydbInstance#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#id AlloydbInstance#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public AlloydbInstance.Builder labels​(Map<String,​String> labels)
        User-defined labels for the alloydb instance.

        **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_instance#labels AlloydbInstance#labels}

        Parameters:
        labels - User-defined labels for the alloydb instance. This parameter is required.
        Returns:
        this

      • machineConfig

        @Stability(Stable)
public AlloydbInstance.Builder machineConfig​(AlloydbInstanceMachineConfig machineConfig)
        machine_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#machine_config AlloydbInstance#machine_config}

        Parameters:
        machineConfig - machine_config block. This parameter is required.
        Returns:
        this

      • networkConfig

        @Stability(Stable)
public AlloydbInstance.Builder networkConfig​(AlloydbInstanceNetworkConfig networkConfig)
        network_config block.

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

        Parameters:
        networkConfig - network_config block. This parameter is required.
        Returns:
        this

      • pscInstanceConfig

        @Stability(Stable)
public AlloydbInstance.Builder pscInstanceConfig​(AlloydbInstancePscInstanceConfig pscInstanceConfig)
        psc_instance_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#psc_instance_config AlloydbInstance#psc_instance_config}

        Parameters:
        pscInstanceConfig - psc_instance_config block. This parameter is required.
        Returns:
        this

      • queryInsightsConfig

        @Stability(Stable)
public AlloydbInstance.Builder queryInsightsConfig​(AlloydbInstanceQueryInsightsConfig queryInsightsConfig)
        query_insights_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#query_insights_config AlloydbInstance#query_insights_config}

        Parameters:
        queryInsightsConfig - query_insights_config block. This parameter is required.
        Returns:
        this

      • readPoolConfig

        @Stability(Stable)
public AlloydbInstance.Builder readPoolConfig​(AlloydbInstanceReadPoolConfig readPoolConfig)
        read_pool_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance#read_pool_config AlloydbInstance#read_pool_config}

        Parameters:
        readPoolConfig - read_pool_config block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public AlloydbInstance.Builder timeouts​(AlloydbInstanceTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this