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

Interface SqlDatabaseInstanceSettings

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

    • Method Detail

      • getTier

        @Stability(Stable)
@NotNull
String getTier()
        The machine type to use.

        See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#tier SqlDatabaseInstance#tier}

      • getActivationPolicy

        @Stability(Stable)
@Nullable
default String getActivationPolicy()
        This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.

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

      • getActiveDirectoryConfig

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsActiveDirectoryConfig getActiveDirectoryConfig()
        active_directory_config block.

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

      • getAdvancedMachineFeatures

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsAdvancedMachineFeatures getAdvancedMachineFeatures()
        advanced_machine_features block.

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

      • getAvailabilityType

        @Stability(Stable)
@Nullable
default String getAvailabilityType()
        The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL).

        For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#availability_type SqlDatabaseInstance#availability_type}

      • getBackupConfiguration

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsBackupConfiguration getBackupConfiguration()
        backup_configuration block.

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

      • getCollation

        @Stability(Stable)
@Nullable
default String getCollation()
        The name of server instance collation.

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

      • getConnectorEnforcement

        @Stability(Stable)
@Nullable
default String getConnectorEnforcement()
        Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections.

        If enabled, all the direct connections are rejected. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#connector_enforcement SqlDatabaseInstance#connector_enforcement}

      • getDatabaseFlags

        @Stability(Stable)
@Nullable
default Object getDatabaseFlags()
        database_flags block.

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

      • getDataCacheConfig

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsDataCacheConfig getDataCacheConfig()
        data_cache_config block.

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

      • getDeletionProtectionEnabled

        @Stability(Stable)
@Nullable
default Object getDeletionProtectionEnabled()
        Configuration to protect against accidental instance deletion.

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

      • getDenyMaintenancePeriod

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsDenyMaintenancePeriod getDenyMaintenancePeriod()
        deny_maintenance_period block.

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

      • getDiskAutoresize

        @Stability(Stable)
@Nullable
default Object getDiskAutoresize()
        Enables auto-resizing of the storage size. Defaults to true.

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

      • getDiskAutoresizeLimit

        @Stability(Stable)
@Nullable
default Number getDiskAutoresizeLimit()
        The maximum size, in GB, to which storage capacity can be automatically increased.

        The default value is 0, which specifies that there is no limit. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#disk_autoresize_limit SqlDatabaseInstance#disk_autoresize_limit}

      • getDiskSize

        @Stability(Stable)
@Nullable
default Number getDiskSize()
        The size of data disk, in GB.

        Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/sql_database_instance#disk_size SqlDatabaseInstance#disk_size}

      • getDiskType

        @Stability(Stable)
@Nullable
default String getDiskType()
        The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.

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

      • getEdition

        @Stability(Stable)
@Nullable
default String getEdition()
        The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.

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

      • getEnableDataplexIntegration

        @Stability(Stable)
@Nullable
default Object getEnableDataplexIntegration()
        Enables Dataplex Integration.

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

      • getEnableGoogleMlIntegration

        @Stability(Stable)
@Nullable
default Object getEnableGoogleMlIntegration()
        Enables Vertex AI Integration.

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

      • getInsightsConfig

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsInsightsConfig getInsightsConfig()
        insights_config block.

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

      • getIpConfiguration

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsIpConfiguration getIpConfiguration()
        ip_configuration block.

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

      • getLocationPreference

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsLocationPreference getLocationPreference()
        location_preference block.

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

      • getMaintenanceWindow

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsMaintenanceWindow getMaintenanceWindow()
        maintenance_window block.

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

      • getPasswordValidationPolicy

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsPasswordValidationPolicy getPasswordValidationPolicy()
        password_validation_policy block.

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

      • getPricingPlan

        @Stability(Stable)
@Nullable
default String getPricingPlan()
        Pricing plan for this instance, can only be PER_USE.

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

      • getSqlServerAuditConfig

        @Stability(Stable)
@Nullable
default SqlDatabaseInstanceSettingsSqlServerAuditConfig getSqlServerAuditConfig()
        sql_server_audit_config block.

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

      • getTimeZone

        @Stability(Stable)
@Nullable
default String getTimeZone()
        The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.

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

      • getUserLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getUserLabels()
        A set of key/value user label pairs to assign to the instance.

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