Settings class

Database instance settings.

Constructors

Settings({Input<SettingsActivationPolicy>? activationPolicy, Input<SqlActiveDirectoryConfig>? activeDirectoryConfig, Input<AdvancedMachineFeatures>? advancedMachineFeatures, Input<List<String>>? authorizedGaeApplications, Input<SettingsAvailabilityType>? availabilityType, Input<BackupConfiguration>? backupConfiguration, Input<String>? collation, Input<SettingsConnectorEnforcement>? connectorEnforcement, Input<bool>? crashSafeReplicationEnabled, Input<DataCacheConfig>? dataCacheConfig, Input<String>? dataDiskSizeGb, Input<SettingsDataDiskType>? dataDiskType, Input<List<DatabaseFlags>>? databaseFlags, Input<bool>? databaseReplicationEnabled, Input<bool>? deletionProtectionEnabled, Input<List<DenyMaintenancePeriod>>? denyMaintenancePeriods, Input<SettingsEdition>? edition, Input<InsightsConfig>? insightsConfig, Input<IpConfiguration>? ipConfiguration, Input<String>? kind, Input<LocationPreference>? locationPreference, Input<MaintenanceWindow>? maintenanceWindow, Input<PasswordValidationPolicy>? passwordValidationPolicy, Input<SettingsPricingPlan>? pricingPlan, Input<SettingsReplicationType>? replicationType, Input<String>? settingsVersion, Input<SqlServerAuditConfig>? sqlServerAuditConfig, Input<bool>? storageAutoResize, Input<String>? storageAutoResizeLimit, Input<String>? tier, Input<String>? timeZone, Input<Map<String, String>>? userLabels})
Creates a new Settings. activationPolicy The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives. activeDirectoryConfig Active Directory configuration, relevant only for Cloud SQL for SQL Server. advancedMachineFeatures Specifies advance machine configuration for the instance relevant only for SQL Server. authorizedGaeApplications The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only. availabilityType Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration. backupConfiguration The daily backup configuration for the instance. collation The name of server Instance collation. connectorEnforcement Specifies if connections must use Cloud SQL connectors. Option values include the following: NOT_REQUIRED (Cloud SQL instances can be connected without Cloud SQL Connectors) and REQUIRED (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. crashSafeReplicationEnabled Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. dataCacheConfig Configuration for data cache. dataDiskSizeGb The size of data disk, in GB. The data disk size minimum is 10GB. dataDiskType The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances. databaseFlags The database flags passed to the instance at startup. databaseReplicationEnabled Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance. deletionProtectionEnabled Configuration to protect against accidental instance deletion. denyMaintenancePeriods Deny maintenance periods edition Optional. The edition of the instance. insightsConfig Insights configuration, for now relevant only for Postgres. ipConfiguration The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. kind This is always sql#settings. locationPreference The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances. maintenanceWindow The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes. passwordValidationPolicy The local user password validation policy of the instance. pricingPlan The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances. replicationType The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances. settingsVersion The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. sqlServerAuditConfig SQL Server specific audit configuration. storageAutoResize Configuration to increase storage size automatically. The default value is true. storageAutoResizeLimit The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. tier The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance. timeZone Server timezone, relevant only for Cloud SQL for SQL Server. userLabels User-provided labels, represented as a dictionary where each label is a single key value pair.
const
Settings.fromMap(Map<String, dynamic> map)
factory

Properties

activationPolicy → Input<SettingsActivationPolicy>?
The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * ALWAYS: The instance is on, and remains so even in the absence of connection requests. * NEVER: The instance is off; it is not activated, even if a connection request arrives.
final
activeDirectoryConfig → Input<SqlActiveDirectoryConfig>?
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
final
advancedMachineFeatures → Input<AdvancedMachineFeatures>?
Specifies advance machine configuration for the instance relevant only for SQL Server.
final
authorizedGaeApplications → Input<List<String>>?
The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
final
availabilityType → Input<SettingsAvailabilityType>?
Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data accessibility. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see Overview of the High Availability Configuration.
final
backupConfiguration → Input<BackupConfiguration>?
The daily backup configuration for the instance.
final
collation → Input<String>?
The name of server Instance collation.
final
connectorEnforcement → Input<SettingsConnectorEnforcement>?
Specifies if connections must use Cloud SQL connectors. Option values include the following: NOT_REQUIRED (Cloud SQL instances can be connected without Cloud SQL Connectors) and REQUIRED (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
final
crashSafeReplicationEnabled → Input<bool>?
Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
final
databaseFlags → Input<List<DatabaseFlags>>?
The database flags passed to the instance at startup.
final
databaseReplicationEnabled → Input<bool>?
Configuration specific to read replica instances. Indicates whether replication is enabled or not. WARNING: Changing this restarts the instance.
final
dataCacheConfig → Input<DataCacheConfig>?
Configuration for data cache.
final
dataDiskSizeGb → Input<String>?
The size of data disk, in GB. The data disk size minimum is 10GB.
final
dataDiskType → Input<SettingsDataDiskType>?
The type of data disk: PD_SSD (default) or PD_HDD. Not used for First Generation instances.
final
deletionProtectionEnabled → Input<bool>?
Configuration to protect against accidental instance deletion.
final
denyMaintenancePeriods → Input<List<DenyMaintenancePeriod>>?
Deny maintenance periods
final
edition → Input<SettingsEdition>?
Optional. The edition of the instance.
final
hashCode → int
The hash code for this object.
no setterinherited
insightsConfig → Input<InsightsConfig>?
Insights configuration, for now relevant only for Postgres.
final
ipConfiguration → Input<IpConfiguration>?
The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
final
kind → Input<String>?
This is always sql#settings.
final
locationPreference → Input<LocationPreference>?
The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or Compute Engine zone for better performance. App Engine co-location was only applicable to First Generation instances.
final
maintenanceWindow → Input<MaintenanceWindow>?
The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
final
passwordValidationPolicy → Input<PasswordValidationPolicy>?
The local user password validation policy of the instance.
final
pricingPlan → Input<SettingsPricingPlan>?
The pricing plan for this instance. This can be either PER_USE or PACKAGE. Only PER_USE is supported for Second Generation instances.
final
replicationType → Input<SettingsReplicationType>?
The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS. (Deprecated) This property was only applicable to First Generation instances.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
settingsVersion → Input<String>?
The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
final
sqlServerAuditConfig → Input<SqlServerAuditConfig>?
SQL Server specific audit configuration.
final
storageAutoResize → Input<bool>?
Configuration to increase storage size automatically. The default value is true.
final
storageAutoResizeLimit → Input<String>?
The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
final
tier → Input<String>?
The tier (or machine type) for this instance, for example db-custom-1-3840. WARNING: Changing this restarts the instance.
final
timeZone → Input<String>?
Server timezone, relevant only for Cloud SQL for SQL Server.
final
userLabels → Input<Map<String, String>>?
User-provided labels, represented as a dictionary where each label is a single key value pair.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited