DatabaseInstance

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

A Cloud SQL instance resource.

interface DatabaseInstance {

readonly availableMaintenanceVersions?: string[];

backendType?:

| "SQL_BACKEND_TYPE_UNSPECIFIED"

| "FIRST_GEN"

| "SECOND_GEN"

| "EXTERNAL";

connectionName?: string;

readonly createTime?: Date;

currentDiskSize?: bigint;

readonly databaseInstalledVersion?: string;

databaseVersion?:

| "SQL_DATABASE_VERSION_UNSPECIFIED"

| "MYSQL_5_1"

| "MYSQL_5_5"

| "MYSQL_5_6"

| "MYSQL_5_7"

| "SQLSERVER_2017_STANDARD"

| "SQLSERVER_2017_ENTERPRISE"

| "SQLSERVER_2017_EXPRESS"

| "SQLSERVER_2017_WEB"

| "POSTGRES_9_6"

| "POSTGRES_10"

| "POSTGRES_11"

| "POSTGRES_12"

| "POSTGRES_13"

| "POSTGRES_14"

| "POSTGRES_15"

| "MYSQL_8_0"

| "MYSQL_8_0_18"

| "MYSQL_8_0_26"

| "MYSQL_8_0_27"

| "MYSQL_8_0_28"

| "MYSQL_8_0_29"

| "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_0_38"

| "MYSQL_8_0_39"

| "MYSQL_8_0_40"

| "SQLSERVER_2019_STANDARD"

| "SQLSERVER_2019_ENTERPRISE"

| "SQLSERVER_2019_EXPRESS"

| "SQLSERVER_2019_WEB"

| "SQLSERVER_2022_STANDARD"

| "SQLSERVER_2022_ENTERPRISE"

| "SQLSERVER_2022_EXPRESS"

| "SQLSERVER_2022_WEB";

diskEncryptionConfiguration?: DiskEncryptionConfiguration;

diskEncryptionStatus?: DiskEncryptionStatus;

readonly dnsName?: string;

etag?: string;

failoverReplica?: {

available?: boolean;

name?: string;

};

gceZone?: string;

geminiConfig?: GeminiInstanceConfig;

instanceType?:

| "SQL_INSTANCE_TYPE_UNSPECIFIED"

| "CLOUD_SQL_INSTANCE"

| "ON_PREMISES_INSTANCE"

| "READ_REPLICA_INSTANCE";

ipAddresses?: IpMapping[];

ipv6Address?: string;

kind?: string;

maintenanceVersion?: string;

masterInstanceName?: string;

maxDiskSize?: bigint;

name?: string;

onPremisesConfiguration?: OnPremisesConfiguration;

outOfDiskReport?: SqlOutOfDiskReport;

readonly primaryDnsName?: string;

project?: string;

readonly pscServiceAttachmentLink?: string;

region?: string;

replicaConfiguration?: ReplicaConfiguration;

replicaNames?: string[];

replicationCluster?: ReplicationCluster;

rootPassword?: string;

satisfiesPzs?: boolean;

scheduledMaintenance?: SqlScheduledMaintenance;

secondaryGceZone?: string;

selfLink?: string;

serverCaCert?: SslCert;

serviceAccountEmailAddress?: string;

settings?: Settings;

sqlNetworkArchitecture?: "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED" | "NEW_NETWORK_ARCHITECTURE" | "OLD_NETWORK_ARCHITECTURE";

state?:

| "SQL_INSTANCE_STATE_UNSPECIFIED"

| "RUNNABLE"

| "SUSPENDED"

| "PENDING_DELETE"

| "PENDING_CREATE"

| "MAINTENANCE"

| "FAILED"

| "ONLINE_MAINTENANCE";

suspensionReason?:

| "SQL_SUSPENSION_REASON_UNSPECIFIED"

| "BILLING_ISSUE"

| "LEGAL_ISSUE"

| "OPERATIONAL_ISSUE"

| "KMS_KEY_ISSUE"[];

readonly writeEndpoint?: string;

}

§Properties

readonly availableMaintenanceVersions?: string[]

[src]

Output only. List all maintenance versions applicable on the instance

backendType?: "SQL_BACKEND_TYPE_UNSPECIFIED" | "FIRST_GEN" | "SECOND_GEN" | "EXTERNAL"

[src]

The backend type. SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type.

connectionName?: string

[src]

Connection name of the Cloud SQL instance used in connection strings.

readonly createTime?: Date

[src]

Output only. The time when the instance was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

currentDiskSize?: bigint

[src]

The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.

readonly databaseInstalledVersion?: string

[src]

Output only. Stores the current database version running on the instance including minor version such as MYSQL_8_0_18.

[src]

The database engine type and version. The databaseVersion field cannot be changed after instance creation.

diskEncryptionConfiguration?: DiskEncryptionConfiguration

[src]

Disk encryption configuration specific to an instance.

diskEncryptionStatus?: DiskEncryptionStatus

[src]

Disk encryption status specific to an instance.

readonly dnsName?: string

[src]

Output only. The dns name of the instance.

etag?: string

[src]

This field is deprecated and will be removed from a future version of the API. Use the settings.settingsVersion field instead.

failoverReplica?: {

available?: boolean;

name?: string;

}

[src]

The name and status of the failover replica.

gceZone?: string

[src]

The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance.

geminiConfig?: GeminiInstanceConfig

[src]

Gemini instance configuration.

instanceType?: "SQL_INSTANCE_TYPE_UNSPECIFIED" | "CLOUD_SQL_INSTANCE" | "ON_PREMISES_INSTANCE" | "READ_REPLICA_INSTANCE"

[src]

The instance type.

ipAddresses?: IpMapping[]

[src]

The assigned IP addresses for the instance.

ipv6Address?: string

[src]

The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.

kind?: string

[src]

This is always sql#instance.

maintenanceVersion?: string

[src]

The current software version on the instance.

masterInstanceName?: string

[src]

The name of the instance which will act as primary in the replication setup.

maxDiskSize?: bigint

[src]

The maximum disk size of the instance in bytes.

name?: string

[src]

Name of the Cloud SQL instance. This does not include the project ID.

onPremisesConfiguration?: OnPremisesConfiguration

[src]

Configuration specific to on-premises instances.

outOfDiskReport?: SqlOutOfDiskReport

[src]

This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job

readonly primaryDnsName?: string

[src]

Output only. DEPRECATED: please use write_endpoint instead.

project?: string

[src]

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

readonly pscServiceAttachmentLink?: string

[src]

Output only. The link to service attachment of PSC instance.

region?: string

[src]

The geographical region of the Cloud SQL instance. It can be one of the regions where Cloud SQL operates: For example, asia-east1, europe-west1, and us-central1. The default value is us-central1.

replicaConfiguration?: ReplicaConfiguration

[src]

Configuration specific to failover replicas and read replicas.

replicaNames?: string[]

[src]

The replicas of the instance.

replicationCluster?: ReplicationCluster

[src]

Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.

rootPassword?: string

[src]

Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.

satisfiesPzs?: boolean

[src]

The status indicating if instance satisfiesPzs. Reserved for future use.

scheduledMaintenance?: SqlScheduledMaintenance

[src]

The start time of any upcoming scheduled maintenance for this instance.

secondaryGceZone?: string

[src]

The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone.

selfLink?: string

[src]

The URI of this resource.

serverCaCert?: SslCert

[src]

SSL configuration.

serviceAccountEmailAddress?: string

[src]

The service account email address assigned to the instance.\This property is read-only.

settings?: Settings

[src]

The user settings.