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

Class AlloydbCluster

  • 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.269Z")
@Stability(Stable)
public class AlloydbCluster
extends com.hashicorp.cdktf.TerraformResource
    Represents a {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster google_alloydb_cluster}.

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • AlloydbCluster

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

      • AlloydbCluster

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

      • AlloydbCluster

        @Stability(Stable)
public AlloydbCluster​(@NotNull
                      software.constructs.Construct scope,
                      @NotNull
                      String id,
                      @NotNull
                      AlloydbClusterConfig config)
        Create a new {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/alloydb_cluster google_alloydb_cluster} 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 AlloydbCluster 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 AlloydbCluster to import. This parameter is required.
        importFromId - The id of the existing AlloydbCluster that should be imported. This parameter is required.
        provider - ? Optional instance of the provider where the AlloydbCluster 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 AlloydbCluster 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 AlloydbCluster to import. This parameter is required.
        importFromId - The id of the existing AlloydbCluster that should be imported. This parameter is required.

      • putAutomatedBackupPolicy

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

      • putContinuousBackupConfig

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

      • putEncryptionConfig

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

      • putInitialUser

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

      • putMaintenanceUpdatePolicy

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

      • putNetworkConfig

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

      • putPscConfig

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

      • putRestoreBackupSource

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

      • putSecondaryConfig

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

      • putTimeouts

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

      • resetAnnotations

        @Stability(Stable)
public void resetAnnotations()

      • resetAutomatedBackupPolicy

        @Stability(Stable)
public void resetAutomatedBackupPolicy()

      • resetClusterType

        @Stability(Stable)
public void resetClusterType()

      • resetContinuousBackupConfig

        @Stability(Stable)
public void resetContinuousBackupConfig()

      • resetDatabaseVersion

        @Stability(Stable)
public void resetDatabaseVersion()

      • resetDeletionPolicy

        @Stability(Stable)
public void resetDeletionPolicy()

      • resetDisplayName

        @Stability(Stable)
public void resetDisplayName()

      • resetEncryptionConfig

        @Stability(Stable)
public void resetEncryptionConfig()

      • resetEtag

        @Stability(Stable)
public void resetEtag()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetInitialUser

        @Stability(Stable)
public void resetInitialUser()

      • resetLabels

        @Stability(Stable)
public void resetLabels()

      • resetMaintenanceUpdatePolicy

        @Stability(Stable)
public void resetMaintenanceUpdatePolicy()

      • resetNetwork

        @Stability(Stable)
public void resetNetwork()

      • resetNetworkConfig

        @Stability(Stable)
public void resetNetworkConfig()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetPscConfig

        @Stability(Stable)
public void resetPscConfig()

      • resetRestoreBackupSource

        @Stability(Stable)
public void resetRestoreBackupSource()

      • resetRestoreContinuousBackupSource

        @Stability(Stable)
public void resetRestoreContinuousBackupSource()

      • resetSecondaryConfig

        @Stability(Stable)
public void resetSecondaryConfig()

      • 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

      • getEffectiveAnnotations

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

      • getEffectiveLabels

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

      • getName

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

      • 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()

      • getAnnotationsInput

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

      • getClusterIdInput

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

      • getClusterTypeInput

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

      • getDatabaseVersionInput

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

      • getDeletionPolicyInput

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

      • getDisplayNameInput

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

      • getEtagInput

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

      • getIdInput

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

      • getLabelsInput

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

      • getLocationInput

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

      • getNetworkInput

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

      • getProjectInput

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

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

      • getClusterId

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

      • setClusterId

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

      • getClusterType

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

      • setClusterType

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

      • getDatabaseVersion

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

      • setDatabaseVersion

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

      • getDeletionPolicy

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

      • setDeletionPolicy

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

      • getDisplayName

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

      • setDisplayName

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

      • getEtag

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

      • setEtag

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

      • getId

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

      • setId

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

      • getLabels

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

      • setLabels

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

      • getLocation

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

      • setLocation

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

      • getNetwork

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

      • setNetwork

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

      • getProject

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

      • setProject

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