GetDatabaseInstanceSetting class
Constructors
-
GetDatabaseInstanceSetting({required Input<String> activationPolicy, required Input<List<GetDatabaseInstanceSettingActiveDirectoryConfig>> activeDirectoryConfigs, required Input<List<GetDatabaseInstanceSettingAdvancedMachineFeature>> advancedMachineFeatures, required Input<bool> autoUpgradeEnabled, required Input<String> availabilityType, required Input<List<GetDatabaseInstanceSettingBackupConfiguration>> backupConfigurations, required Input<String> collation, required Input<List<GetDatabaseInstanceSettingConnectionPoolConfig>> connectionPoolConfigs, required Input<String> connectorEnforcement, required Input<String> dataApiAccess, required Input<List<GetDatabaseInstanceSettingDataCacheConfig>> dataCacheConfigs, required Input<int> dataDiskProvisionedIops, required Input<int> dataDiskProvisionedThroughput, required Input<List<GetDatabaseInstanceSettingDatabaseFlag>> databaseFlags, required Input<bool> deletionProtectionEnabled, required Input<List<GetDatabaseInstanceSettingDenyMaintenancePeriod>> denyMaintenancePeriods, required Input<bool> diskAutoresize, required Input<int> diskAutoresizeLimit, required Input<int> diskSize, required Input<String> diskType, required Input<String> edition, required Input<String> effectiveAvailabilityType, required Input<bool> enableDataplexIntegration, required Input<bool> enableGoogleMlIntegration, required Input<List<GetDatabaseInstanceSettingEntraidConfig>> entraidConfigs, required Input<List<GetDatabaseInstanceSettingFinalBackupConfig>> finalBackupConfigs, required Input<List<GetDatabaseInstanceSettingInsightsConfig>> insightsConfigs, required Input<List<GetDatabaseInstanceSettingIpConfiguration>> ipConfigurations, required Input<List<GetDatabaseInstanceSettingLocationPreference>> locationPreferences, required Input<List<GetDatabaseInstanceSettingMaintenanceWindow>> maintenanceWindows, required Input<List<GetDatabaseInstanceSettingPasswordValidationPolicy>> passwordValidationPolicies, required Input<List<GetDatabaseInstanceSettingPerformanceCaptureConfig>> performanceCaptureConfigs, required Input<String> pricingPlan, required Input<List<GetDatabaseInstanceSettingReadPoolAutoScaleConfig>> readPoolAutoScaleConfigs, required Input<int> replicationLagMaxSeconds, required Input<bool> retainBackupsOnDelete, required Input<List<GetDatabaseInstanceSettingSqlServerAuditConfig>> sqlServerAuditConfigs, required Input<String> tier, required Input<String> timeZone, required Input<Map<String, String>> userLabels, required Input<int> version})
-
Creates a new GetDatabaseInstanceSetting.
activationPolicy This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
activeDirectoryConfigs Required.
advancedMachineFeatures Required.
autoUpgradeEnabled Enables Automatic Version Upgrade feature. Can be used with MySQL only.
availabilityType The availability type of the Cloud SQL instance, high availability
backupConfigurations Required.
collation The name of server instance collation.
connectionPoolConfigs The managed connection pool setting for a Cloud SQL instance.
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.
dataApiAccess Allows using ExecuteSql API to connect to the instance. Disallowed when unspecified.
dataCacheConfigs Data cache configurations.
dataDiskProvisionedIops Provisioned number of I/O operations per second for the data disk. This field is only used for HYPERDISK_BALANCED disk types.
dataDiskProvisionedThroughput Provisioned throughput measured in MiB per second for the data disk. This field is only used for HYPERDISK_BALANCED disk types.
databaseFlags Required.
deletionProtectionEnabled Configuration to protect against accidental instance deletion.
denyMaintenancePeriods Required.
diskAutoresize Enables auto-resizing of the storage size. Defaults to true.
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.
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 for PD_SSD, PD_HDD and 20GB for HYPERDISK_BALANCED.
diskType The type of supported data disk is tier dependent and can be PD_SSD or PD_HDD or HYPERDISK_BALANCED.
edition The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
effectiveAvailabilityType The availability type of the Cloud SQL instance, high availability
enableDataplexIntegration Enables Dataplex Integration.
enableGoogleMlIntegration Enables Vertex AI Integration.
entraidConfigs The Microsoft Entra ID configuration for the SQL Server instance.
finalBackupConfigs Config used to determine the final backup settings for the instance
insightsConfigs Configuration of Query Insights.
ipConfigurations Required.
locationPreferences Required.
maintenanceWindows Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
passwordValidationPolicies Required.
performanceCaptureConfigs Configuration of Performance Capture.
pricingPlan Pricing plan for this instance, can only be PER_USE.
readPoolAutoScaleConfigs Configuration of Read Pool Auto Scale.
replicationLagMaxSeconds The acceptable replication lag, in seconds, after which a read replica recreates itself. The lag must persist for at least five minutes before recreation is triggered. This is a replica level field, and must be between 300 seconds (five minutes) and 31536000 seconds (one year).
retainBackupsOnDelete When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
sqlServerAuditConfigs Required.
tier 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.
timeZone The timeZone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
userLabels A set of key/value user label pairs to assign to the instance.
version Used to make sure changes to the settings block are atomic.
const
-
GetDatabaseInstanceSetting.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
activationPolicy
→ Input<String>
-
This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND.
final
-
activeDirectoryConfigs
→ Input<List<GetDatabaseInstanceSettingActiveDirectoryConfig>>
-
final
-
advancedMachineFeatures
→ Input<List<GetDatabaseInstanceSettingAdvancedMachineFeature>>
-
final
-
autoUpgradeEnabled
→ Input<bool>
-
Enables Automatic Version Upgrade feature. Can be used with MySQL only.
final
-
availabilityType
→ Input<String>
-
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.
For read pool instances, this field is read-only. The availability type is changed by specifying
the number of nodes (node_count).
final
-
backupConfigurations
→ Input<List<GetDatabaseInstanceSettingBackupConfiguration>>
-
final
-
collation
→ Input<String>
-
The name of server instance collation.
final
-
connectionPoolConfigs
→ Input<List<GetDatabaseInstanceSettingConnectionPoolConfig>>
-
The managed connection pool setting for a Cloud SQL instance.
final
-
connectorEnforcement
→ Input<String>
-
Enables the enforcement of Cloud SQL Auth Proxy or Cloud SQL connectors for all the connections. If enabled, all the direct connections are rejected.
final
-
dataApiAccess
→ Input<String>
-
Allows using ExecuteSql API to connect to the instance. Disallowed when unspecified.
final
-
databaseFlags
→ Input<List<GetDatabaseInstanceSettingDatabaseFlag>>
-
final
-
dataCacheConfigs
→ Input<List<GetDatabaseInstanceSettingDataCacheConfig>>
-
Data cache configurations.
final
-
dataDiskProvisionedIops
→ Input<int>
-
Provisioned number of I/O operations per second for the data disk. This field is only used for HYPERDISK_BALANCED disk types.
final
-
dataDiskProvisionedThroughput
→ Input<int>
-
Provisioned throughput measured in MiB per second for the data disk. This field is only used for HYPERDISK_BALANCED disk types.
final
-
deletionProtectionEnabled
→ Input<bool>
-
Configuration to protect against accidental instance deletion.
final
-
denyMaintenancePeriods
→ Input<List<GetDatabaseInstanceSettingDenyMaintenancePeriod>>
-
final
-
diskAutoresize
→ Input<bool>
-
Enables auto-resizing of the storage size. Defaults to true.
final
-
diskAutoresizeLimit
→ Input<int>
-
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.
final
-
diskSize
→ Input<int>
-
The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB for PD_SSD, PD_HDD and 20GB for HYPERDISK_BALANCED.
final
-
diskType
→ Input<String>
-
The type of supported data disk is tier dependent and can be PD_SSD or PD_HDD or HYPERDISK_BALANCED.
final
-
edition
→ Input<String>
-
The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS.
final
-
effectiveAvailabilityType
→ Input<String>
-
The availability type of the Cloud SQL instance, high availability
(REGIONAL) or single zone (ZONAL). This field always contains the value that is reported by the
API (for read pools, effectiveAvailabilityType may differ from availability_type).
final
-
enableDataplexIntegration
→ Input<bool>
-
Enables Dataplex Integration.
final
-
enableGoogleMlIntegration
→ Input<bool>
-
Enables Vertex AI Integration.
final
-
entraidConfigs
→ Input<List<GetDatabaseInstanceSettingEntraidConfig>>
-
The Microsoft Entra ID configuration for the SQL Server instance.
final
-
finalBackupConfigs
→ Input<List<GetDatabaseInstanceSettingFinalBackupConfig>>
-
Config used to determine the final backup settings for the instance
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
insightsConfigs
→ Input<List<GetDatabaseInstanceSettingInsightsConfig>>
-
Configuration of Query Insights.
final
-
ipConfigurations
→ Input<List<GetDatabaseInstanceSettingIpConfiguration>>
-
final
-
locationPreferences
→ Input<List<GetDatabaseInstanceSettingLocationPreference>>
-
final
-
maintenanceWindows
→ Input<List<GetDatabaseInstanceSettingMaintenanceWindow>>
-
Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time.
final
-
passwordValidationPolicies
→ Input<List<GetDatabaseInstanceSettingPasswordValidationPolicy>>
-
final
-
performanceCaptureConfigs
→ Input<List<GetDatabaseInstanceSettingPerformanceCaptureConfig>>
-
Configuration of Performance Capture.
final
-
pricingPlan
→ Input<String>
-
Pricing plan for this instance, can only be PER_USE.
final
-
readPoolAutoScaleConfigs
→ Input<List<GetDatabaseInstanceSettingReadPoolAutoScaleConfig>>
-
Configuration of Read Pool Auto Scale.
final
-
replicationLagMaxSeconds
→ Input<int>
-
The acceptable replication lag, in seconds, after which a read replica recreates itself. The lag must persist for at least five minutes before recreation is triggered. This is a replica level field, and must be between 300 seconds (five minutes) and 31536000 seconds (one year).
final
-
retainBackupsOnDelete
→ Input<bool>
-
When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
sqlServerAuditConfigs
→ Input<List<GetDatabaseInstanceSettingSqlServerAuditConfig>>
-
final
-
tier
→ Input<String>
-
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.
final
-
timeZone
→ Input<String>
-
The timeZone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format.
final
-
userLabels
→ Input<Map<String, String>>
-
A set of key/value user label pairs to assign to the instance.
final
-
version
→ Input<int>
-
Used to make sure changes to the settings block are atomic.
final
