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

Interface SqlDatabaseInstanceConfig

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

    • Method Detail

      • getDatabaseVersion

        @Stability(Stable)
@NotNull
String getDatabaseVersion()
        The MySQL, PostgreSQL or SQL Server (beta) version to use.

        Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#database_version SqlDatabaseInstance#database_version}

      • getClone

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceClone getClone()
        clone block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#clone SqlDatabaseInstance#clone}

      • getDeletionProtection

        @Stability(Stable)
@Nullable
default Object getDeletionProtection()
        Used to block Terraform from deleting a SQL Instance. Defaults to true.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#deletion_protection SqlDatabaseInstance#deletion_protection}

      • getEncryptionKeyName

        @Stability(Stable)
@Nullable
default String getEncryptionKeyName()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#encryption_key_name SqlDatabaseInstance#encryption_key_name}.

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#id SqlDatabaseInstance#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.

      • getInstanceType

        @Stability(Stable)
@Nullable
default String getInstanceType()
        The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#instance_type SqlDatabaseInstance#instance_type}

      • getMaintenanceVersion

        @Stability(Stable)
@Nullable
default String getMaintenanceVersion()
        Maintenance version.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#maintenance_version SqlDatabaseInstance#maintenance_version}

      • getMasterInstanceName

        @Stability(Stable)
@Nullable
default String getMasterInstanceName()
        The name of the instance that will act as the master in the replication setup.

        Note, this requires the master to have binary_log_enabled set, as well as existing backups. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#master_instance_name SqlDatabaseInstance#master_instance_name}

      • getName

        @Stability(Stable)
@Nullable
default String getName()
        The name of the instance.

        If the name is left blank, Terraform will randomly generate one when the instance is first created. This is done because after a name is used, it cannot be reused for up to one week. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#name SqlDatabaseInstance#name}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        The ID of the project in which the resource belongs.

        If it is not provided, the provider project is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#project SqlDatabaseInstance#project}

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        The region the instance will sit in.

        Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#region SqlDatabaseInstance#region}

      • getReplicaConfiguration

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceReplicaConfiguration getReplicaConfiguration()
        replica_configuration block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#replica_configuration SqlDatabaseInstance#replica_configuration}

      • getRestoreBackupContext

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceRestoreBackupContext getRestoreBackupContext()
        restore_backup_context block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#restore_backup_context SqlDatabaseInstance#restore_backup_context}

      • getRootPassword

        @Stability(Stable)
@Nullable
default String getRootPassword()
        Initial root password. Required for MS SQL Server.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#root_password SqlDatabaseInstance#root_password}

      • getSettings

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettings getSettings()
        settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#settings SqlDatabaseInstance#settings}

      • getTimeouts

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

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