CloudSqlSettings class

Settings for creating a Cloud SQL database instance.

Constructors

CloudSqlSettings({Input<CloudSqlSettingsActivationPolicy>? activationPolicy, Input<bool>? autoStorageIncrease, Input<CloudSqlSettingsAvailabilityType>? availabilityType, Input<String>? cmekKeyName, Input<String>? collation, Input<DataCacheConfig>? dataCacheConfig, Input<String>? dataDiskSizeGb, Input<CloudSqlSettingsDataDiskType>? dataDiskType, Input<Map<String, String>>? databaseFlags, Input<CloudSqlSettingsDatabaseVersion>? databaseVersion, Input<CloudSqlSettingsEdition>? edition, Input<SqlIpConfig>? ipConfig, Input<String>? rootPassword, Input<String>? secondaryZone, Input<String>? sourceId, Input<String>? storageAutoResizeLimit, Input<String>? tier, Input<Map<String, String>>? userLabels, Input<String>? zone})
Creates a new CloudSqlSettings. 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. autoStorageIncrease default: ON If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB. availabilityType Optional. Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available). cmekKeyName The KMS key name used for the csql instance. collation The Cloud SQL default instance level collation. dataCacheConfig Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation. dataDiskSizeGb The storage capacity available to the database, in GB. The minimum (and default) size is 10GB. dataDiskType The type of storage: PD_SSD (default) or PD_HDD. databaseFlags The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. databaseVersion The database engine type and version. edition Optional. The edition of the given Cloud SQL instance. ipConfig 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. rootPassword Input only. Initial root password. secondaryZone Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available). sourceId The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID 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-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings. userLabels The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }. zone The Google Cloud Platform zone where your Cloud SQL database instance is located.
const
CloudSqlSettings.fromMap(Map<String, dynamic> map)
factory

Properties

activationPolicy → Input<CloudSqlSettingsActivationPolicy>?
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
autoStorageIncrease → Input<bool>?
default: ON If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.
final
availabilityType → Input<CloudSqlSettingsAvailabilityType>?
Optional. Availability type. Potential values: * ZONAL: The instance serves data from only one zone. Outages in that zone affect data availability. * REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).
final
cmekKeyName → Input<String>?
The KMS key name used for the csql instance.
final
collation → Input<String>?
The Cloud SQL default instance level collation.
final
databaseFlags → Input<Map<String, String>>?
The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
final
databaseVersion → Input<CloudSqlSettingsDatabaseVersion>?
The database engine type and version.
final
dataCacheConfig → Input<DataCacheConfig>?
Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see Data cache overview in Cloud SQL documentation.
final
dataDiskSizeGb → Input<String>?
The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.
final
dataDiskType → Input<CloudSqlSettingsDataDiskType>?
The type of storage: PD_SSD (default) or PD_HDD.
final
edition → Input<CloudSqlSettingsEdition>?
Optional. The edition of the given Cloud SQL instance.
final
hashCode → int
The hash code for this object.
no setterinherited
ipConfig → Input<SqlIpConfig>?
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.
final
rootPassword → Input<String>?
Input only. Initial root password.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryZone → Input<String>?
Optional. The Google Cloud Platform zone where the failover Cloud SQL database instance is located. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
final
sourceId → Input<String>?
The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID
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-n1-standard-1 (MySQL instances) or db-custom-1-3840 (PostgreSQL instances). For more information, see Cloud SQL Instance Settings.
final
userLabels → Input<Map<String, String>>?
The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "18kg", "count": "3" }.
final
zone → Input<String>?
The Google Cloud Platform zone where your Cloud SQL database instance is located.
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