Package com.hashicorp.cdktf.providers.google.sql_database_instance

Class SqlDatabaseInstance

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

    • Field Detail

      • TF_RESOURCE_TYPE

        @Stability(Stable)
public static final String TF_RESOURCE_TYPE

    • Constructor Detail

      • SqlDatabaseInstance

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

      • SqlDatabaseInstance

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

      • SqlDatabaseInstance

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

      • putClone

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

      • putSettings

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

      • putTimeouts

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

      • resetClone

        @Stability(Stable)
public void resetClone()

      • resetDeletionProtection

        @Stability(Stable)
public void resetDeletionProtection()

      • resetEncryptionKeyName

        @Stability(Stable)
public void resetEncryptionKeyName()

      • resetId

        @Stability(Stable)
public void resetId()

      • resetInstanceType

        @Stability(Stable)
public void resetInstanceType()

      • resetMaintenanceVersion

        @Stability(Stable)
public void resetMaintenanceVersion()

      • resetMasterInstanceName

        @Stability(Stable)
public void resetMasterInstanceName()

      • resetName

        @Stability(Stable)
public void resetName()

      • resetProject

        @Stability(Stable)
public void resetProject()

      • resetRegion

        @Stability(Stable)
public void resetRegion()

      • resetReplicaConfiguration

        @Stability(Stable)
public void resetReplicaConfiguration()

      • resetRestoreBackupContext

        @Stability(Stable)
public void resetRestoreBackupContext()

      • resetRootPassword

        @Stability(Stable)
public void resetRootPassword()

      • resetSettings

        @Stability(Stable)
public void resetSettings()

      • 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

      • getAvailableMaintenanceVersions

        @Stability(Stable)
@NotNull
public List<String> getAvailableMaintenanceVersions()

      • getConnectionName

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

      • getDnsName

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

      • getFirstIpAddress

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

      • getPrivateIpAddress

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

      • getPscServiceAttachmentLink

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

      • getPublicIpAddress

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

      • getSelfLink

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

      • getServiceAccountEmailAddress

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

      • getDatabaseVersionInput

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

      • getDeletionProtectionInput

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

      • getEncryptionKeyNameInput

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

      • getIdInput

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

      • getInstanceTypeInput

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

      • getMaintenanceVersionInput

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

      • getMasterInstanceNameInput

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

      • getNameInput

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

      • getProjectInput

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

      • getRegionInput

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

      • getRootPasswordInput

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

      • getTimeoutsInput

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

      • getDatabaseVersion

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

      • setDatabaseVersion

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

      • getDeletionProtection

        @Stability(Stable)
@NotNull
public Object getDeletionProtection()

      • setDeletionProtection

        @Stability(Stable)
public void setDeletionProtection​(@NotNull
                                  Boolean value)

      • setDeletionProtection

        @Stability(Stable)
public void setDeletionProtection​(@NotNull
                                  com.hashicorp.cdktf.IResolvable value)

      • getEncryptionKeyName

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

      • setEncryptionKeyName

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

      • getId

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

      • setId

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

      • getInstanceType

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

      • setInstanceType

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

      • getMaintenanceVersion

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

      • setMaintenanceVersion

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

      • getMasterInstanceName

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

      • setMasterInstanceName

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

      • getName

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

      • setName

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

      • getProject

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

      • setProject

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

      • getRegion

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

      • setRegion

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

      • getRootPassword

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

      • setRootPassword

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