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

Interface AlloydbInstanceConfig

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

    • Method Detail

      • getCluster

        @Stability(Stable)
@NotNull
String getCluster()
        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}

      • getInstanceId

        @Stability(Stable)
@NotNull
String getInstanceId()
        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}

      • getInstanceType

        @Stability(Stable)
@NotNull
String getInstanceType()
        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}

      • 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.

        **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}

      • getAvailabilityType

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

      • getClientConnectionConfig

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

      • getDatabaseFlags

        @Stability(Stable)
@Nullable
default Map<String,​String> getDatabaseFlags()
        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}

      • getDisplayName

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

      • getGceZone

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

      • 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_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.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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}

      • getMachineConfig

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

      • getNetworkConfig

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

      • getPscInstanceConfig

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

      • getQueryInsightsConfig

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

      • getReadPoolConfig

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

      • getTimeouts

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

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