Database Migration v1 API - Class CloudSqlSettings (2.3.0)

public sealed class CloudSqlSettings : IMessage<CloudSqlSettings>, IEquatable<CloudSqlSettings>, IDeepCloneable<CloudSqlSettings>, IBufferMessage, IMessage

Reference documentation and code samples for the Database Migration v1 API class CloudSqlSettings.

Settings for creating a Cloud SQL database instance.

Inheritance

object > CloudSqlSettings

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

CloudSqlSettings()

public CloudSqlSettings()

CloudSqlSettings(CloudSqlSettings)

public CloudSqlSettings(CloudSqlSettings other)
Parameter
NameDescription
otherCloudSqlSettings

Properties

ActivationPolicy

public CloudSqlSettings.Types.SqlActivationPolicy ActivationPolicy { get; set; }

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.

Property Value
TypeDescription
CloudSqlSettingsTypesSqlActivationPolicy

AutoStorageIncrease

public bool? AutoStorageIncrease { get; set; }

[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.

Property Value
TypeDescription
bool

AvailabilityType

public CloudSqlSettings.Types.SqlAvailabilityType AvailabilityType { get; set; }

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).
Property Value
TypeDescription
CloudSqlSettingsTypesSqlAvailabilityType

CmekKeyName

public string CmekKeyName { get; set; }

The KMS key name used for the csql instance.

Property Value
TypeDescription
string

Collation

public string Collation { get; set; }

The Cloud SQL default instance level collation.

Property Value
TypeDescription
string

DataDiskSizeGb

public long? DataDiskSizeGb { get; set; }

The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

Property Value
TypeDescription
long

DataDiskType

public CloudSqlSettings.Types.SqlDataDiskType DataDiskType { get; set; }

The type of storage: PD_SSD (default) or PD_HDD.

Property Value
TypeDescription
CloudSqlSettingsTypesSqlDataDiskType

DatabaseFlags

public MapField<string, string> DatabaseFlags { get; }

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" }.

Property Value
TypeDescription
MapFieldstringstring

DatabaseVersion

public CloudSqlSettings.Types.SqlDatabaseVersion DatabaseVersion { get; set; }

The database engine type and version.

Property Value
TypeDescription
CloudSqlSettingsTypesSqlDatabaseVersion

Edition

public CloudSqlSettings.Types.Edition Edition { get; set; }

Optional. The edition of the given Cloud SQL instance.

Property Value
TypeDescription
CloudSqlSettingsTypesEdition

IpConfig

public SqlIpConfig IpConfig { get; set; }

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.

Property Value
TypeDescription
SqlIpConfig

RootPassword

public string RootPassword { get; set; }

Input only. Initial root password.

Property Value
TypeDescription
string

RootPasswordSet

public bool RootPasswordSet { get; set; }

Output only. Indicates If this connection profile root password is stored.

Property Value
TypeDescription
bool

SecondaryZone

public string SecondaryZone { get; set; }

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).

Property Value
TypeDescription
string

SourceId

public string SourceId { get; set; }

The Database Migration Service source connection profile ID, in the format: projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID

Property Value
TypeDescription
string

StorageAutoResizeLimit

public long? StorageAutoResizeLimit { get; set; }

The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

Property Value
TypeDescription
long

Tier

public string Tier { get; set; }

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.

Property Value
TypeDescription
string

UserLabels

public MapField<string, string> UserLabels { get; }

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" }.

Property Value
TypeDescription
MapFieldstringstring

Zone

public string Zone { get; set; }

The Google Cloud Platform zone where your Cloud SQL database instance is located.

Property Value
TypeDescription
string