Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CloudSqlSettings

import type { CloudSqlSettings } from "https://googleapis.deno.dev/v1/datamigration:v1.ts";

Settings for creating a Cloud SQL database instance.

interface CloudSqlSettings {
activationPolicy?: "SQL_ACTIVATION_POLICY_UNSPECIFIED" | "ALWAYS" | "NEVER";
autoStorageIncrease?: boolean;
availabilityType?: "SQL_AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL";
cmekKeyName?: string;
collation?: string;
databaseFlags?: {
[key: string]: string;
}
;
databaseVersion?:
| "SQL_DATABASE_VERSION_UNSPECIFIED"
| "MYSQL_5_6"
| "MYSQL_5_7"
| "MYSQL_8_0"
| "MYSQL_8_0_18"
| "MYSQL_8_0_26"
| "MYSQL_8_0_27"
| "MYSQL_8_0_28"
| "MYSQL_8_0_30"
| "MYSQL_8_0_31"
| "MYSQL_8_0_32"
| "MYSQL_8_0_33"
| "MYSQL_8_0_34"
| "MYSQL_8_0_35"
| "MYSQL_8_0_36"
| "MYSQL_8_0_37"
| "MYSQL_8_4"
| "POSTGRES_9_6"
| "POSTGRES_11"
| "POSTGRES_10"
| "POSTGRES_12"
| "POSTGRES_13"
| "POSTGRES_14"
| "POSTGRES_15"
| "POSTGRES_16";
databaseVersionName?: string;
dataCacheConfig?: DataCacheConfig;
dataDiskSizeGb?: bigint;
dataDiskType?: "SQL_DATA_DISK_TYPE_UNSPECIFIED" | "PD_SSD" | "PD_HDD";
edition?: "EDITION_UNSPECIFIED" | "ENTERPRISE" | "ENTERPRISE_PLUS";
ipConfig?: SqlIpConfig;
rootPassword?: string;
readonly rootPasswordSet?: boolean;
secondaryZone?: string;
sourceId?: string;
storageAutoResizeLimit?: bigint;
tier?: string;
userLabels?: {
[key: string]: string;
}
;
zone?: string;
}

§Properties

§
activationPolicy?: "SQL_ACTIVATION_POLICY_UNSPECIFIED" | "ALWAYS" | "NEVER"
[src]

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?: boolean
[src]

[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?: "SQL_AVAILABILITY_TYPE_UNSPECIFIED" | "ZONAL" | "REGIONAL"
[src]

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?: string
[src]

The KMS key name used for the csql instance.

§
collation?: string
[src]

The Cloud SQL default instance level collation.

§
databaseFlags?: {
[key: string]: string;
}
[src]

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?: "SQL_DATABASE_VERSION_UNSPECIFIED" | "MYSQL_5_6" | "MYSQL_5_7" | "MYSQL_8_0" | "MYSQL_8_0_18" | "MYSQL_8_0_26" | "MYSQL_8_0_27" | "MYSQL_8_0_28" | "MYSQL_8_0_30" | "MYSQL_8_0_31" | "MYSQL_8_0_32" | "MYSQL_8_0_33" | "MYSQL_8_0_34" | "MYSQL_8_0_35" | "MYSQL_8_0_36" | "MYSQL_8_0_37" | "MYSQL_8_4" | "POSTGRES_9_6" | "POSTGRES_11" | "POSTGRES_10" | "POSTGRES_12" | "POSTGRES_13" | "POSTGRES_14" | "POSTGRES_15" | "POSTGRES_16"
[src]

The database engine type and version. Deprecated. Use database_version_name instead.

§
databaseVersionName?: string
[src]

Optional. The database engine type and version name.

§
dataCacheConfig?: DataCacheConfig
[src]

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?: bigint
[src]

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

§
dataDiskType?: "SQL_DATA_DISK_TYPE_UNSPECIFIED" | "PD_SSD" | "PD_HDD"
[src]

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

§
edition?: "EDITION_UNSPECIFIED" | "ENTERPRISE" | "ENTERPRISE_PLUS"
[src]

Optional. The edition of the given Cloud SQL instance.

§
ipConfig?: SqlIpConfig
[src]

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?: string
[src]

Input only. Initial root password.

§
readonly rootPasswordSet?: boolean
[src]

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

§
secondaryZone?: string
[src]

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?: string
[src]

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

§
storageAutoResizeLimit?: bigint
[src]

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

§
tier?: string
[src]

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?: {
[key: string]: string;
}
[src]

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?: string
[src]

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