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

Class AlloydbInstance

  • All Implemented Interfaces:
    com.hashicorp.cdktf.IInterpolatingParent, com.hashicorp.cdktf.ITerraformAddressable, com.hashicorp.cdktf.ITerraformDependable, com.hashicorp.cdktf.ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:17.296Z")
@Stability(Stable)
public class AlloydbInstance
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance google_alloydb_instance}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • AlloydbInstance

        protected AlloydbInstance​(software.amazon.jsii.JsiiObjectRef objRef)

      • AlloydbInstance

        protected AlloydbInstance​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • AlloydbInstance

        @Stability(Stable)
public AlloydbInstance​(@NotNull
                       software.constructs.Construct scope,
                       @NotNull
                       String id,
                       @NotNull
                       AlloydbInstanceConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_instance google_alloydb_instance} Resource.

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        config - This parameter is required.

    • Method Detail

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId,
                                                                             @Nullable
                                                                             com.hashicorp.cdktf.TerraformProvider provider)
        Generates CDKTF code for importing a AlloydbInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the AlloydbInstance to import. This parameter is required.
        importFromId - The id of the existing AlloydbInstance that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the AlloydbInstance to import is found.

      • generateConfigForImport

        @Stability(Stable)
@NotNull
public static com.hashicorp.cdktf.ImportableResource generateConfigForImport​(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String importToId,
                                                                             @NotNull
                                                                             String importFromId)
        Generates CDKTF code for importing a AlloydbInstance resource upon running "cdktf plan ".

        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        importToId - The construct id used in the generated config for the AlloydbInstance to import. This parameter is required.
        importFromId - The id of the existing AlloydbInstance that should be imported. This parameter is required.

      • putClientConnectionConfig

        @Stability(Stable)
public void putClientConnectionConfig​(@NotNull
                                      AlloydbInstanceClientConnectionConfig value)
        Parameters:
        value - This parameter is required.

      • putMachineConfig

        @Stability(Stable)
public void putMachineConfig​(@NotNull
                             AlloydbInstanceMachineConfig value)
        Parameters:
        value - This parameter is required.

      • putNetworkConfig

        @Stability(Stable)
public void putNetworkConfig​(@NotNull
                             AlloydbInstanceNetworkConfig value)
        Parameters:
        value - This parameter is required.

      • putPscInstanceConfig

        @Stability(Stable)
public void putPscInstanceConfig​(@NotNull
                                 AlloydbInstancePscInstanceConfig value)
        Parameters:
        value - This parameter is required.

      • putQueryInsightsConfig

        @Stability(Stable)
public void putQueryInsightsConfig​(@NotNull
                                   AlloydbInstanceQueryInsightsConfig value)
        Parameters:
        value - This parameter is required.

      • putReadPoolConfig

        @Stability(Stable)
public void putReadPoolConfig​(@NotNull
                              AlloydbInstanceReadPoolConfig value)
        Parameters:
        value - This parameter is required.

      • putTimeouts

        @Stability(Stable)
public void putTimeouts​(@NotNull
                        AlloydbInstanceTimeouts value)
        Parameters:
        value - This parameter is required.

      • resetAnnotations

        @Stability(Stable)
public void resetAnnotations()

      • resetAvailabilityType

        @Stability(Stable)
public void resetAvailabilityType()

      • resetClientConnectionConfig

        @Stability(Stable)
public void resetClientConnectionConfig()

      • resetDatabaseFlags

        @Stability(Stable)
public void resetDatabaseFlags()

      • resetDisplayName

        @Stability(Stable)
public void resetDisplayName()

      • resetGceZone

        @Stability(Stable)
public void resetGceZone()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetMachineConfig

        @Stability(Stable)
public void resetMachineConfig()

      • resetNetworkConfig

        @Stability(Stable)
public void resetNetworkConfig()

      • resetPscInstanceConfig

        @Stability(Stable)
public void resetPscInstanceConfig()

      • resetQueryInsightsConfig

        @Stability(Stable)
public void resetQueryInsightsConfig()

      • resetReadPoolConfig

        @Stability(Stable)
public void resetReadPoolConfig()

      • resetTimeouts

        @Stability(Stable)
public void resetTimeouts()

      • synthesizeAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeAttributes()
        Overrides:
        synthesizeAttributes in class com.hashicorp.cdktf.TerraformResource

      • synthesizeHclAttributes

        @Stability(Stable)
@NotNull
protected Map<String,​Object> synthesizeHclAttributes()
        Overrides:
        synthesizeHclAttributes in class com.hashicorp.cdktf.TerraformResource

      • getCreateTime

        @Stability(Stable)
@NotNull
public String getCreateTime()

      • getEffectiveAnnotations

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveAnnotations()

      • getEffectiveLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getEffectiveLabels()

      • getIpAddress

        @Stability(Stable)
@NotNull
public String getIpAddress()

      • getName

        @Stability(Stable)
@NotNull
public String getName()

      • getPublicIpAddress

        @Stability(Stable)
@NotNull
public String getPublicIpAddress()

      • getReconciling

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.IResolvable getReconciling()

      • getState

        @Stability(Stable)
@NotNull
public String getState()

      • getTerraformLabels

        @Stability(Stable)
@NotNull
public com.hashicorp.cdktf.StringMap getTerraformLabels()

      • getUid

        @Stability(Stable)
@NotNull
public String getUid()

      • getUpdateTime

        @Stability(Stable)
@NotNull
public String getUpdateTime()

      • getAnnotationsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getAnnotationsInput()

      • getAvailabilityTypeInput

        @Stability(Stable)
@Nullable
public String getAvailabilityTypeInput()

      • getClusterInput

        @Stability(Stable)
@Nullable
public String getClusterInput()

      • getDatabaseFlagsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getDatabaseFlagsInput()

      • getDisplayNameInput

        @Stability(Stable)
@Nullable
public String getDisplayNameInput()

      • getGceZoneInput

        @Stability(Stable)
@Nullable
public String getGceZoneInput()

      • getIdInput

        @Stability(Stable)
@Nullable
public String getIdInput()

      • getInstanceIdInput

        @Stability(Stable)
@Nullable
public String getInstanceIdInput()

      • getInstanceTypeInput

        @Stability(Stable)
@Nullable
public String getInstanceTypeInput()

      • getLabelsInput

        @Stability(Stable)
@Nullable
public Map<String,​String> getLabelsInput()

      • getTimeoutsInput

        @Stability(Stable)
@Nullable
public Object getTimeoutsInput()

      • getAnnotations

        @Stability(Stable)
@NotNull
public Map<String,​String> getAnnotations()

      • setAnnotations

        @Stability(Stable)
public void setAnnotations​(@NotNull
                           Map<String,​String> value)

      • getAvailabilityType

        @Stability(Stable)
@NotNull
public String getAvailabilityType()

      • setAvailabilityType

        @Stability(Stable)
public void setAvailabilityType​(@NotNull
                                String value)

      • getCluster

        @Stability(Stable)
@NotNull
public String getCluster()

      • setCluster

        @Stability(Stable)
public void setCluster​(@NotNull
                       String value)

      • getDatabaseFlags

        @Stability(Stable)
@NotNull
public Map<String,​String> getDatabaseFlags()

      • setDatabaseFlags

        @Stability(Stable)
public void setDatabaseFlags​(@NotNull
                             Map<String,​String> value)

      • getDisplayName

        @Stability(Stable)
@NotNull
public String getDisplayName()

      • setDisplayName

        @Stability(Stable)
public void setDisplayName​(@NotNull
                           String value)

      • getGceZone

        @Stability(Stable)
@NotNull
public String getGceZone()

      • setGceZone

        @Stability(Stable)
public void setGceZone​(@NotNull
                       String value)

      • getId

        @Stability(Stable)
@NotNull
public String getId()

      • setId

        @Stability(Stable)
public void setId​(@NotNull
                  String value)

      • getInstanceId

        @Stability(Stable)
@NotNull
public String getInstanceId()

      • setInstanceId

        @Stability(Stable)
public void setInstanceId​(@NotNull
                          String value)

      • getInstanceType

        @Stability(Stable)
@NotNull
public String getInstanceType()

      • setInstanceType

        @Stability(Stable)
public void setInstanceType​(@NotNull
                            String value)

      • getLabels

        @Stability(Stable)
@NotNull
public Map<String,​String> getLabels()

      • setLabels

        @Stability(Stable)
public void setLabels​(@NotNull
                      Map<String,​String> value)