Class SqlDatabaseInstanceSettings.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.sql_database_instance.SqlDatabaseInstanceSettings.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<SqlDatabaseInstanceSettings>
- Enclosing interface:
- SqlDatabaseInstanceSettings
@Stability(Stable) public static final class SqlDatabaseInstanceSettings.Builder extends Object implements software.amazon.jsii.Builder<SqlDatabaseInstanceSettings>
A builder forSqlDatabaseInstanceSettings
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
tier
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder tier(String tier)
Sets the value ofSqlDatabaseInstanceSettings.getTier()- Parameters:
tier- The machine type to use. This parameter is required. 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}- Returns:
this
-
activationPolicy
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder activationPolicy(String activationPolicy)
Sets the value ofSqlDatabaseInstanceSettings.getActivationPolicy()- Parameters:
activationPolicy- 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}- Returns:
this
-
activeDirectoryConfig
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder activeDirectoryConfig(SqlDatabaseInstanceSettingsActiveDirectoryConfig activeDirectoryConfig)
Sets the value ofSqlDatabaseInstanceSettings.getActiveDirectoryConfig()- Parameters:
activeDirectoryConfig- 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}- Returns:
this
-
advancedMachineFeatures
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder advancedMachineFeatures(SqlDatabaseInstanceSettingsAdvancedMachineFeatures advancedMachineFeatures)
Sets the value ofSqlDatabaseInstanceSettings.getAdvancedMachineFeatures()- Parameters:
advancedMachineFeatures- 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}- Returns:
this
-
availabilityType
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder availabilityType(String availabilityType)
Sets the value ofSqlDatabaseInstanceSettings.getAvailabilityType()- Parameters:
availabilityType- 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}- Returns:
this
-
backupConfiguration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder backupConfiguration(SqlDatabaseInstanceSettingsBackupConfiguration backupConfiguration)
Sets the value ofSqlDatabaseInstanceSettings.getBackupConfiguration()- Parameters:
backupConfiguration- 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}- Returns:
this
-
collation
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder collation(String collation)
Sets the value ofSqlDatabaseInstanceSettings.getCollation()- Parameters:
collation- 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}- Returns:
this
-
connectorEnforcement
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder connectorEnforcement(String connectorEnforcement)
Sets the value ofSqlDatabaseInstanceSettings.getConnectorEnforcement()- Parameters:
connectorEnforcement- 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}- Returns:
this
-
databaseFlags
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder databaseFlags(com.hashicorp.cdktf.IResolvable databaseFlags)
Sets the value ofSqlDatabaseInstanceSettings.getDatabaseFlags()- Parameters:
databaseFlags- 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}- Returns:
this
-
databaseFlags
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder databaseFlags(List<? extends SqlDatabaseInstanceSettingsDatabaseFlags> databaseFlags)
Sets the value ofSqlDatabaseInstanceSettings.getDatabaseFlags()- Parameters:
databaseFlags- 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}- Returns:
this
-
dataCacheConfig
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder dataCacheConfig(SqlDatabaseInstanceSettingsDataCacheConfig dataCacheConfig)
Sets the value ofSqlDatabaseInstanceSettings.getDataCacheConfig()- Parameters:
dataCacheConfig- 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}- Returns:
this
-
deletionProtectionEnabled
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
Sets the value ofSqlDatabaseInstanceSettings.getDeletionProtectionEnabled()- Parameters:
deletionProtectionEnabled- 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}- Returns:
this
-
deletionProtectionEnabled
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder deletionProtectionEnabled(com.hashicorp.cdktf.IResolvable deletionProtectionEnabled)
Sets the value ofSqlDatabaseInstanceSettings.getDeletionProtectionEnabled()- Parameters:
deletionProtectionEnabled- 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}- Returns:
this
-
denyMaintenancePeriod
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder denyMaintenancePeriod(SqlDatabaseInstanceSettingsDenyMaintenancePeriod denyMaintenancePeriod)
Sets the value ofSqlDatabaseInstanceSettings.getDenyMaintenancePeriod()- Parameters:
denyMaintenancePeriod- 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}- Returns:
this
-
diskAutoresize
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder diskAutoresize(Boolean diskAutoresize)
Sets the value ofSqlDatabaseInstanceSettings.getDiskAutoresize()- Parameters:
diskAutoresize- 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}- Returns:
this
-
diskAutoresize
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder diskAutoresize(com.hashicorp.cdktf.IResolvable diskAutoresize)
Sets the value ofSqlDatabaseInstanceSettings.getDiskAutoresize()- Parameters:
diskAutoresize- 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}- Returns:
this
-
diskAutoresizeLimit
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder diskAutoresizeLimit(Number diskAutoresizeLimit)
Sets the value ofSqlDatabaseInstanceSettings.getDiskAutoresizeLimit()- Parameters:
diskAutoresizeLimit- 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}- Returns:
this
-
diskSize
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder diskSize(Number diskSize)
Sets the value ofSqlDatabaseInstanceSettings.getDiskSize()- Parameters:
diskSize- 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}- Returns:
this
-
diskType
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder diskType(String diskType)
Sets the value ofSqlDatabaseInstanceSettings.getDiskType()- Parameters:
diskType- 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}- Returns:
this
-
edition
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder edition(String edition)
Sets the value ofSqlDatabaseInstanceSettings.getEdition()- Parameters:
edition- 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}- Returns:
this
-
enableDataplexIntegration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder enableDataplexIntegration(Boolean enableDataplexIntegration)
Sets the value ofSqlDatabaseInstanceSettings.getEnableDataplexIntegration()- Parameters:
enableDataplexIntegration- 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}- Returns:
this
-
enableDataplexIntegration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder enableDataplexIntegration(com.hashicorp.cdktf.IResolvable enableDataplexIntegration)
Sets the value ofSqlDatabaseInstanceSettings.getEnableDataplexIntegration()- Parameters:
enableDataplexIntegration- 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}- Returns:
this
-
enableGoogleMlIntegration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder enableGoogleMlIntegration(Boolean enableGoogleMlIntegration)
Sets the value ofSqlDatabaseInstanceSettings.getEnableGoogleMlIntegration()- Parameters:
enableGoogleMlIntegration- 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}- Returns:
this
-
enableGoogleMlIntegration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder enableGoogleMlIntegration(com.hashicorp.cdktf.IResolvable enableGoogleMlIntegration)
Sets the value ofSqlDatabaseInstanceSettings.getEnableGoogleMlIntegration()- Parameters:
enableGoogleMlIntegration- 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}- Returns:
this
-
insightsConfig
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder insightsConfig(SqlDatabaseInstanceSettingsInsightsConfig insightsConfig)
Sets the value ofSqlDatabaseInstanceSettings.getInsightsConfig()- Parameters:
insightsConfig- 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}- Returns:
this
-
ipConfiguration
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder ipConfiguration(SqlDatabaseInstanceSettingsIpConfiguration ipConfiguration)
Sets the value ofSqlDatabaseInstanceSettings.getIpConfiguration()- Parameters:
ipConfiguration- 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}- Returns:
this
-
locationPreference
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder locationPreference(SqlDatabaseInstanceSettingsLocationPreference locationPreference)
Sets the value ofSqlDatabaseInstanceSettings.getLocationPreference()- Parameters:
locationPreference- 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}- Returns:
this
-
maintenanceWindow
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder maintenanceWindow(SqlDatabaseInstanceSettingsMaintenanceWindow maintenanceWindow)
Sets the value ofSqlDatabaseInstanceSettings.getMaintenanceWindow()- Parameters:
maintenanceWindow- 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}- Returns:
this
-
passwordValidationPolicy
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder passwordValidationPolicy(SqlDatabaseInstanceSettingsPasswordValidationPolicy passwordValidationPolicy)
Sets the value ofSqlDatabaseInstanceSettings.getPasswordValidationPolicy()- Parameters:
passwordValidationPolicy- 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}- Returns:
this
-
pricingPlan
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder pricingPlan(String pricingPlan)
Sets the value ofSqlDatabaseInstanceSettings.getPricingPlan()- Parameters:
pricingPlan- 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}- Returns:
this
-
sqlServerAuditConfig
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder sqlServerAuditConfig(SqlDatabaseInstanceSettingsSqlServerAuditConfig sqlServerAuditConfig)
Sets the value ofSqlDatabaseInstanceSettings.getSqlServerAuditConfig()- Parameters:
sqlServerAuditConfig- 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}- Returns:
this
-
timeZone
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder timeZone(String timeZone)
Sets the value ofSqlDatabaseInstanceSettings.getTimeZone()- Parameters:
timeZone- 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}- Returns:
this
-
userLabels
@Stability(Stable) public SqlDatabaseInstanceSettings.Builder userLabels(Map<String,String> userLabels)
Sets the value ofSqlDatabaseInstanceSettings.getUserLabels()- Parameters:
userLabels- 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}- Returns:
this
-
build
@Stability(Stable) public SqlDatabaseInstanceSettings build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<SqlDatabaseInstanceSettings>- Returns:
- a new instance of
SqlDatabaseInstanceSettings - Throws:
NullPointerException- if any required attribute was not provided
-
-