gcp_sql_database_instance

`ancestors`

タイプ: UNORDERED_LIST_STRING

`available_maintenance_versions`

タイプ: UNORDERED_LIST_STRING
プロバイダー名: availableMaintenanceVersions
説明: 出力のみ。インスタンスに適用されるすべてのメンテナンスバージョンをリストアップします

`backend_type`

タイプ: STRING
プロバイダー名: backendType
説明: バックエンドのタイプ。SECOND_GEN: クラウド SQL データベースのインスタンス。EXTERNAL: Google が管理していないデータベースサーバー。このプロパティは読み取り専用です。データベースの種類を決定するには、settings オブジェクトの tier プロパティを使用します。
可能な値:

SQL_BACKEND_TYPE_UNSPECIFIED - これは、例えば不明なバックエンドの種類です。
FIRST_GEN - V1 スペックルインスタンス。
SECOND_GEN - V2 スペックルインスタンス。
EXTERNAL - オンプレミスインスタンス。

`connection_name`

タイプ: STRING
プロバイダー名: connectionName
説明: 接続文字列で使用されるクラウド SQL インスタンスの接続名。

`create_time`

タイプ: TIMESTAMP
Provider name: createTime
説明: 出力のみ。インスタンスが作成された時刻。RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z のようになります。

`current_disk_size`

タイプ: INT64
プロバイダー名: currentDiskSize
説明: インスタンスの現在のディスク使用量 (バイト単位)。このプロパティは非推奨となりました。代わりに Cloud Monitoring API の “cloudsql.googleapis.com/database/disk/bytes_used” メトリクスを使用してください。詳しくはこの発表をご覧ください。

`database_installed_version`

タイプ: STRING
プロバイダー名: databaseInstalledVersion
説明: 出力のみ。MYSQL_8_0_18 のようなマイナーバージョンを含む、インスタンス上で動作している現在のデータベースバージョンを格納します。

`database_version`

タイプ: STRING
プロバイダー名: databaseVersion
説明: データベースエンジンの種類とバージョン。databaseVersion フィールドはインスタンス作成後に変更することはできません。
可能な値:

SQL_DATABASE_VERSION_UNSPECIFIED - これは、不明なデータベースのバージョンです。
MYSQL_5_1 - データベースのバージョンは、MySQL 5.1 です。
MYSQL_5_5 - データベースのバージョンは、MySQL 5.5 です。
MYSQL_5_6 - データベースのバージョンは、MySQL 5.6 です。
MYSQL_5_7 - データベースのバージョンは、MySQL 5.7 です。
SQLSERVER_2017_STANDARD - データベースのバージョンは、SQL Server 2017 Standard です。
SQLSERVER_2017_ENTERPRISE - データベースのバージョンは、SQL Server 2017 Enterprise です。
SQLSERVER_2017_EXPRESS - データベースのバージョンは、SQL Server 2017 Express です。
SQLSERVER_2017_WEB - データベースのバージョンは、SQL Server 2017 Web です。
POSTGRES_9_6 - データベースのバージョンは、PostgreSQL 9.6 です。
POSTGRES_10 - データベースのバージョンは、PostgreSQL 10 です。
POSTGRES_11 - データベースのバージョンは、PostgreSQL 11 です。
POSTGRES_12 - データベースのバージョンは、PostgreSQL 12 です。
POSTGRES_13 - データベースのバージョンは、PostgreSQL 13 です。
POSTGRES_14 - データベースのバージョンは、PostgreSQL 14 です。
MYSQL_8_0 - データベースのバージョンは、MySQL 8 です。
MYSQL_8_0_18 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 18 です。
MYSQL_8_0_26 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 26 です。
MYSQL_8_0_27 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 27 です。
MYSQL_8_0_28 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 28 です。
MYSQL_8_0_29 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 29 です。
MYSQL_8_0_30 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 30 です。
MYSQL_8_0_31 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 31 です。
MYSQL_8_0_32 - データベースのメジャーバージョンは MySQL 8.0、マイナーバージョンは 32 です。
SQLSERVER_2019_STANDARD - データベースのバージョンは、SQL Server 2019 Standard です。
SQLSERVER_2019_ENTERPRISE - データベースのバージョンは、SQL Server 2019 Enterprise です。
SQLSERVER_2019_EXPRESS - データベースのバージョンは、SQL Server 2019 Express です。
SQLSERVER_2019_WEB - データベースのバージョンは、SQL Server 2019 Web です。

`disk_encryption_configuration`

タイプ: STRUCT
プロバイダー名: diskEncryptionConfiguration
説明: インスタンスに固有のディスク暗号化構成。

kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#diskEncryptionConfiguration です。
kms_key_name
タイプ: STRING
プロバイダー名: kmsKeyName
説明: ディスク暗号化用 KMS キーのリソース名

`disk_encryption_status`

タイプ: STRUCT
プロバイダー名: diskEncryptionStatus
説明: インスタンスに固有のディスク暗号化ステータス。

kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#diskEncryptionStatus です。
kms_key_version_name
タイプ: STRING
プロバイダー名: kmsKeyVersionName
説明: Cloud SQL インスタンスリソースの暗号化に使用した KMS キーのバージョン

`etag`

タイプ: STRING
プロバイダー名: etag
説明: このフィールドは非推奨で、API の将来のバージョンでは削除される予定です。代わりに settings.settingsVersion フィールドを使用してください。

`failover_replica`

タイプ: STRUCT
プロバイダー名: failoverReplica
説明: フェイルオーバーレプリカの名前とステータス。

available
タイプ: BOOLEAN
プロバイダー名: available
説明: フェイルオーバーレプリカの有効性ステータスです。false のステータスは、フェイルオーバーレプリカが同期していないことを示します。プライマリインスタンスは、このステータスが true のときのみフェイルオーバーレプリカにフェイルオーバーすることができます。
name
タイプ: STRING
プロバイダー名: name
説明: フェイルオーバーレプリカの名前。インスタンス作成時に指定すると、そのインスタンスに対してフェイルオーバーレプリカが作成されます。この名前にはプロジェクト ID は含まれません。

`gce_zone`

タイプ: STRING
プロバイダー名: gceZone
説明: インスタンスが現在サービスを提供している Compute Engine のゾーン。この値は、インスタンスがセカンダリゾーンにフェイルオーバーした場合、インスタンスの作成時に指定されたゾーンと異なる可能性があります。警告: これを変更すると、インスタンスが再起動する場合があります。

`instance_type`

タイプ: STRING
プロバイダー名: instanceType
説明: インスタンスタイプ。
可能な値:

SQL_INSTANCE_TYPE_UNSPECIFIED - これは、不明な Cloud SQL インスタンスタイプです。
CLOUD_SQL_INSTANCE - プライマリインスタンスからレプリケートされていない通常の Cloud SQL インスタンス。
ON_PREMISES_INSTANCE - Cloud SQL で管理されていない、顧客構内で稼働しているインスタンス。
READ_REPLICA_INSTANCE - リードレプリカとして動作する Cloud SQL インスタンス。

`ip_addresses`

タイプ: UNORDERED_LIST_STRUCT
プロバイダー名: ipAddresses
説明: インスタンスに割り当てられた IP アドレス。

ip_address
タイプ: STRING
プロバイダー名: ipAddress
説明: 割り当てられた IP アドレス。
time_to_retire
タイプ: TIMESTAMP
プロバイダー名: timeToRetire
説明: この IP がリタイアする予定時刻を RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z のように指定します。このフィールドは、IP がリタイアする予定のときにのみ利用可能です。
type
タイプ: STRING
プロバイダー名: type
説明: この IP アドレスのタイプ。PRIMARY アドレスはパブリックアドレスで、着信接続を受け入れることができます。PRIVATE アドレスは、着信接続を受け入れることができるプライベートなアドレスです。OUTGOING アドレスは、サポートされている場合、インスタンスから発信される接続の発信元アドレスです。
可能な値:
- SQL_IP_ADDRESS_TYPE_UNSPECIFIED - これは、不明な IP アドレスタイプです。
- PRIMARY - 顧客が接続することになっている IP アドレス。通常、これはロードバランサーの IP アドレスです。
- OUTGOING - リードレプリカがその外部プライマリインスタンスに確立する接続のソース IP アドレス。この IP アドレスは、構内のプライマリインスタンスへの着信接続をフィルターするファイアウォールがある場合、顧客が許可リストに入れることができます。
- PRIVATE - プライベート IP やネットワークピアリングを利用する際に使用するプライベート IP。
- MIGRATED_1ST_GEN - 移行したインスタンスの V1 IP。移行が完了したらすぐにこの IP を廃止してください。注: V1 IP アドレスを持つ V1 インスタンスは、PRIMARY としてカウントされます。

`ipv6_address`

タイプ: STRING
プロバイダー名: ipv6Address
説明: インスタンスに割り当てられた IPv6 アドレス。(非推奨) このプロパティは、第一世代のインスタンスにのみ適用可能でした。

`kind`

タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#instance です。

`labels`

タイプ: UNORDERED_LIST_STRING

`maintenance_version`

タイプ: STRING
プロバイダー名: maintenanceVersion
説明: インスタンス上の現在のソフトウェアバージョン。

`master_instance_name`

タイプ: STRING
プロバイダー名: masterInstanceName
説明: レプリケーション設定においてプライマリとして動作するインスタンスの名前。

`max_disk_size`

タイプ: INT64
プロバイダー名: maxDiskSize
説明: インスタンスの最大ディスクサイズ (バイト単位)。

`name`

タイプ: STRING
プロバイダー名: name
説明: Cloud SQL インスタンスの名前。プロジェクト ID は含まれません。

`on_premises_configuration`

タイプ: STRUCT
プロバイダー名: onPremisesConfiguration
説明: オンプレミスインスタンスに特化した構成。

ca_certificate
タイプ: STRING
プロバイダー名: caCertificate
説明: 信頼できる CA の x509 証明書の PEM 表現。
client_certificate
タイプ: STRING
プロバイダー名: clientCertificate
説明: レプリカの x509 証明書の PEM 表現。
client_key
タイプ: STRING
プロバイダー名: clientKey
説明: レプリカの秘密鍵の PEM 表現。対応する公開キーは、クライアントの証明書にエンコードされています。
dump_file_path
タイプ: STRING
プロバイダー名: dumpFilePath
説明: Cloud SQL レプリカを作成するためのダンプファイル。
host_port
タイプ: STRING
プロバイダー名: hostPort
説明: オンプレミスインスタンスのホストとポート (host:port 形式)
kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#onPremisesConfiguration です。
password
タイプ: STRING
プロバイダー名: password
説明: オンプレミスインスタンスに接続するためのパスワード。
source_instance
タイプ: STRUCT
プロバイダー名: sourceInstance
説明: ソースが Cloud SQL の場合、Cloud SQL インスタンスへの参照。
- name
  タイプ: STRING
  プロバイダー名: name
  説明: 参照する Cloud SQL インスタンスの名前。プロジェクト ID は含まれません。
- project
  タイプ: STRING
  プロバイダー名: project
  説明: 参照する Cloud SQL インスタンスのプロジェクト ID。デフォルトは、参照しているインスタンスと同じプロジェクト ID です。
- region
  タイプ: STRING
  プロバイダー名: region
  説明: 参照されている Cloud SQL インスタンスのリージョン。
username
タイプ: STRING
プロバイダー名: username
説明: オンプレミスインスタンスに接続するためのユーザー名。

`organization_id`

タイプ: STRING

`out_of_disk_report`

タイプ: STRUCT
プロバイダー名: outOfDiskReport
説明: このフィールドは、OutOfDisk 問題に対するプロアクティブデータベースウェルネスジョブが生成するレポートを表します。* ライター: * OOD のプロアクティブデータベースウェルネスジョブ。* リーダー: * プロアクティブデータベースウェルネスジョブ

sql_min_recommended_increase_size_gb
タイプ: INT32
プロバイダー名: sqlMinRecommendedIncreaseSizeGb
説明: 最小推奨増加サイズ (ギガバイト単位)。このフィールドは、フロントエンドによって消費されます。* ライター: * OOD のプロアクティブデータベースウェルネスジョブ。* リーダー:
sql_out_of_disk_state
タイプ: STRING
プロバイダー名: sqlOutOfDiskState
説明: このフィールドは、OutOfDisk 問題に対するプロアクティブデータベースウェルネスジョブが生成する状態を表します。* ライター: * OOD のプロアクティブデータベースウェルネスジョブ。* リーダー: * プロアクティブデータベースウェルネスジョブ
可能な値:
- SQL_OUT_OF_DISK_STATE_UNSPECIFIED - 未指定の状態
- NORMAL - インスタンスのデータディスクに十分な空き容量があります
- SOFT_SHUTDOWN - データディスクをほぼ使い切った状態です。データの破損を防ぐためにシャットダウンされます。

`parent`

タイプ: STRING

`project`

タイプ: STRING
プロバイダー名: project
説明: Cloud SQL インスタンスを含むプロジェクトのプロジェクト ID。該当する場合は、Google アプリのドメインがプレフィックスとして付きます。

`project_id`

タイプ: STRING

`project_number`

タイプ: STRING

`region`

タイプ: STRING
プロバイダー名: region
説明: 地理的な地域。* us-central (FIRST_GEN インスタンスのみ) * us-central1 (SECOND_GEN インスタンスのみ) * asia-east1 または europe-west1 が可能です。デフォルトは、インスタンスタイプに応じて us-central または us-central1 です。インスタンス作成後に地域を変更することはできません。

`replica_configuration`

タイプ: STRUCT
プロバイダー名: replicaConfiguration
説明: フェイルオーバーレプリカとリードレプリカに特化した構成。

failover_target
タイプ: BOOLEAN
プロバイダー名: failoverTarget
説明: レプリカがフェイルオーバーのターゲットであるかどうかを指定します。このフィールドを true に設定すると、レプリカはフェイルオーバーレプリカとして指定されます。プライマリインスタンスに障害が発生した場合、そのレプリカインスタンスが新しいプライマリインスタンスとして昇格します。フェイルオーバーの対象として指定できるレプリカは 1 つだけで、そのレプリカはプライマリインスタンスと異なるゾーンにある必要があります。
kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#replicaConfiguration です。
mysql_replica_configuration
タイプ: STRUCT
プロバイダー名: mysqlReplicaConfiguration
説明: MySQL オンプレミスプライマリインスタンスからレプリケーションを行う際の MySQL 固有の構成。ユーザー名、パスワード、証明書、キーなどのレプリケーション構成情報は、インスタンスのメタデータには保存されません。構成情報はレプリケーション接続のセットアップにのみ使用され、MySQL によってデータディレクトリの master.info というファイルに保存されます。
- ca_certificate
  タイプ: STRING
  プロバイダー名: caCertificate
  説明: 信頼できる CA の x509 証明書の PEM 表現。
- client_certificate
  タイプ: STRING
  プロバイダー名: clientCertificate
  説明: レプリカの x509 証明書の PEM 表現。
- client_key
  タイプ: STRING
  プロバイダー名: clientKey
  説明: レプリカの秘密鍵の PEM 表現。対応する公開キーは、クライアントの証明書にエンコードされています。
- connect_retry_interval
  タイプ: INT32
  プロバイダー名: connectRetryInterval
  説明: 接続の再試行までの待ち時間 (秒単位)。MySQL のデフォルトは 60 秒です。
- dump_file_path
  タイプ: STRING
  プロバイダー名: dumpFilePath
  説明: レプリカインスタンスの作成元となる、Google Cloud Storage にある SQL ダンプファイルへのパス。URI は gs://bucketName/fileName の形式です。圧縮された gzip ファイル (.gz) もサポートされています。ダンプには、レプリケーションを開始する binlog 座標を指定します。これは、mysqldump を使用する際に –master-data を 1 に設定することで実現可能です。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#mysqlReplicaConfiguration です。
- master_heartbeat_period
  タイプ: INT64
  プロバイダー名: masterHeartbeatPeriod
  説明: レプリケーションのハートビート間の間隔 (ミリ秒)。
- password
  タイプ: STRING
  プロバイダー名: password
  説明: レプリケーション接続のパスワード。
- ssl_cipher
  タイプ: STRING
  プロバイダー名: sslCipher
  説明: SSL 暗号化に使用する権限ある暗号のリスト。
- username
  タイプ: STRING
  プロバイダー名: username
  説明: レプリケーション接続のユーザー名。
- verify_server_certificate
  タイプ: BOOLEAN
  プロバイダー名: verifyServerCertificate
  説明: プライマリインスタンスが SSL ハンドシェイク中に送信する証明書の Common Name の値をチェックするかどうか。

`replica_names`

タイプ: UNORDERED_LIST_STRING
プロバイダー名: replicaNames
説明: インスタンスのレプリカ。

`resource_name`

タイプ: STRING

`root_password`

タイプ: STRING
プロバイダー名: rootPassword
説明: ルートパスワードの初期値。作成時のみ使用します。PostgreSQL インスタンスに接続する前に、ルートパスワードを設定する必要があります。

`satisfies_pzs`

タイプ: BOOLEAN
プロバイダー名: satisfiesPzs
説明: インスタンスが Pzs を満たすかどうかを示すステータス。将来の使用のために予約されています。

`scheduled_maintenance`

タイプ: STRUCT
プロバイダー名: scheduledMaintenance
説明: このインスタンスに対して今後予定されているメンテナンスの開始時間。

can_defer
タイプ: BOOLEAN
プロバイダー名: canDefer
can_reschedule
タイプ: BOOLEAN
プロバイダー名: canReschedule
説明: スケジュールメンテナンスの再スケジューリングが可能かどうか。
schedule_deadline_time
タイプ: TIMESTAMP
プロバイダー名: scheduleDeadlineTime
説明: この期限を過ぎてのメンテナンス開始の再スケジューリングはできません。
start_time
タイプ: TIMESTAMP
プロバイダー名: startTime
説明: このインスタンスに対して今後予定されているメンテナンスの開始時間。

`secondary_gce_zone`

タイプ: STRING
プロバイダー名: secondaryGceZone
説明: リージョンインスタンスの場合、フェイルオーバーインスタンスが現在サービスを提供している Compute Engine のゾーン。この値は、インスタンスがセカンダリ/フェイルオーバーゾーンにフェイルオーバーした場合、インスタンスの作成時に指定されたゾーンと異なる可能性があります。

`self_link`

タイプ: STRING
プロバイダー名: selfLink
説明: このリソースの URI。

`server_ca_cert`

タイプ: STRUCT
プロバイダー名: serverCaCert
説明: SSL 構成。

cert
タイプ: STRING
プロバイダー名: cert
説明: PEM 表現。
cert_serial_number
タイプ: STRING
プロバイダー名: certSerialNumber
説明: 証明書から抽出されたシリアル番号。
common_name
タイプ: STRING
プロバイダー名: commonName
説明: ユーザー提供の名前。[a-zA-Z.-_ ]+ に制限されています。
create_time
タイプ: TIMESTAMP
プロバイダー名: createTime
説明: 証明書が作成された時刻。RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z のようになります。
expiration_time
タイプ: TIMESTAMP
プロバイダー名: expirationTime
説明: 証明書の有効期限。RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z のようになります。
instance
タイプ: STRING
プロバイダー名: instance
説明: データベースインスタンスの名前。
kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#sslCert です。
self_link
タイプ: STRING
プロバイダー名: selfLink
説明: このリソースの URI。
sha1_fingerprint
タイプ: STRING
プロバイダー名: sha1Fingerprint
説明: Sha1 フィンガープリント。

`service_account_email_address`

タイプ: STRING
プロバイダー名: serviceAccountEmailAddress
説明: インスタンスに割り当てられたサービスアカウントのメールアドレス。このプロパティは読み取り専用です。

`settings`

タイプ: STRUCT
プロバイダー名: settings
説明: ユーザー設定。

activation_policy
タイプ: STRING
プロバイダー名: activationPolicy
説明: アクティブ化ポリシーは、インスタンスがいつアクティブになるかを指定します。これは、インスタンスの状態が RUNNABLE である場合にのみ適用されます。有効な値: * ALWAYS: インスタンスはオンになっており、接続リクエストがない場合でもそのままの状態を保ちます。* NEVER: インスタンスはオフで、接続リクエストが来てもアクティブになりません。
可能な値:
- SQL_ACTIVATION_POLICY_UNSPECIFIED - 不明なアクティブ化プラン。
- ALWAYS - インスタンスは常に稼働しています。
- NEVER - インスタンスが起動することはありません。
- ON_DEMAND - インスタンスはリクエストを受けると起動します。
active_directory_config
タイプ: STRUCT
プロバイダー名: activeDirectoryConfig
説明: Active Directory の構成。Cloud SQL for SQL Server のみに関連します。
- domain
  タイプ: STRING
  プロバイダー名: domain
  説明: ドメイン名 (例: mydomain.com)。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#activeDirectoryConfig です。
advanced_machine_features
タイプ: STRUCT
プロバイダー名: advancedMachineFeatures
説明: SQL Server のみに関連するインスタンスの事前マシン構成を指定します。
- threads_per_core
  タイプ: INT32
  プロバイダー名: threadsPerCore
  説明: 物理コアあたりのスレッド数。
authorized_gae_applications
タイプ: UNORDERED_LIST_STRING
プロバイダー名: authorizedGaeApplications
説明: このインスタンスにアクセスできる App Engine のアプリ ID。(非推奨) First Generation インスタンスにのみ適用されます。
availability_type
タイプ: STRING
プロバイダー名: availabilityType
説明: 可用性タイプ。想定される値: * ZONAL: インスタンスは 1 つのゾーンのみからデータを提供します。そのゾーンで障害が発生した場合、データアクセスに影響があります。* REGIONAL: インスタンスはリージョン内の複数のゾーンからデータを提供できます (高可用性です)。詳しくは、高可用性構成の概要を参照してください。
可能な値:
- SQL_AVAILABILITY_TYPE_UNSPECIFIED - これは不明な可用性タイプです。
- ZONAL - ゾーンで利用可能なインスタンス。
- REGIONAL - リージョンで利用可能なインスタンス。
backup_configuration
タイプ: STRUCT
プロバイダー名: backupConfiguration
説明: インスタンスの日次バックアップ構成。
- backup_retention_settings
  タイプ: STRUCT
  プロバイダー名: backupRetentionSettings
  説明: バックアップの保持設定。
  - retained_backups
    タイプ: INT32
    プロバイダー名: retainedBackups
    説明: retention_unit の値に応じて、バックアップを削除する必要があるかどうかを判断するために使用されます。retention_unit が ‘COUNT’ の場合、この数のバックアップを保持することになります。
  - retention_unit
    タイプ: STRING
    プロバイダー名: retentionUnit
    説明: ‘retained_backups’ が表す単位。
    可能な値:
    - RETENTION_UNIT_UNSPECIFIED - バックアップの保持単位は未指定で、COUNT として扱われます。
    - COUNT - バックアップの保持は、「直近の 7 つのバックアップを保持する」のように、回数で指定します。
- binary_log_enabled
  タイプ: BOOLEAN
  プロバイダー名: binaryLogEnabled
  説明: (MySQL のみ) バイナリログが有効かどうか。バックアップ構成が無効の場合、バイナリログも無効にする必要があります。
- enabled
  タイプ: BOOLEAN
  プロバイダー名: enabled
  説明: この構成が有効であるかどうか。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#backupConfiguration です。
- location
  タイプ: STRING
  プロバイダー名: location
  説明: バックアップの場所
- point_in_time_recovery_enabled
  タイプ: BOOLEAN
  プロバイダー名: pointInTimeRecoveryEnabled
  説明: (Postgres のみ) ポイントインタイムリカバリーが有効かどうか。
- replication_log_archiving_enabled
  タイプ: BOOLEAN
  プロバイダー名: replicationLogArchivingEnabled
  説明: 将来の使用に備えた予約。
- start_time
  タイプ: STRING
  プロバイダー名: startTime
  説明: 毎日のバックアップ構成の開始時刻。UTC タイムゾーンで、24 時間形式 - HH:MM で指定します。
- transaction_log_retention_days
  タイプ: INT32
  プロバイダー名: transactionLogRetentionDays
  説明: ポイントインタイムリストアのために保持するトランザクションログの日数 (1～7)。
collation
タイプ: STRING
プロバイダー名: collation
説明: サーバーインスタンス照合の名前。
connector_enforcement
タイプ: STRING
プロバイダー名: connectorEnforcement
説明: 接続にクラウド SQL コネクターを使用しなければならないかどうかを指定します。オプションの値は以下の通りです。NOT_REQUIRED (Cloud SQL インスタンスは Cloud SQL Connectors なしで接続可能) と REQUIRED (Cloud SQL Connectors を使用する接続のみ許可) REQUIRED を使用すると、既存のすべての認可されたネットワークが無効になることに注意してください。新規インスタンス作成時にこのフィールドを指定しない場合、NOT_REQUIRED が使用されます。既存のインスタンスにパッチを適用したり更新したりする際にこのフィールドが指定されない場合、そのインスタンスでは変更されずにそのまま残ります。
可能な値:
- CONNECTOR_ENFORCEMENT_UNSPECIFIED - Cloud SQL コネクターの要件は不明です。
- NOT_REQUIRED - Cloud SQL コネクターを要求しません。
- REQUIRED - Cloud SQL Auth Proxy と Cloud SQL Java、Python、Go コネクターを含む、すべての接続に Cloud SQL コネクターを使用するよう要求します。注: これは、既存のすべての認可されたネットワークを無効にします。
crash_safe_replication_enabled
タイプ: BOOLEAN
プロバイダー名: crashSafeReplicationEnabled
説明: リードレプリカインスタンスに固有の構成。クラッシュセーフレプリケーションのためのデータベースフラグが有効であるかどうかを示します。このプロパティは、第一世代のインスタンスにのみ適用可能でした。
data_disk_size_gb
タイプ: INT64
プロバイダー名: dataDiskSizeGb
説明: データディスクのサイズ (GB 単位)。データディスクの最小サイズは 10GB です。
data_disk_type
タイプ: STRING
プロバイダー名: dataDiskType
説明: データディスクのデータタイプ: PD_SSD (デフォルト) または PD_HDD。第一世代のインスタンスでは使用されません。
可能な値:
- SQL_DATA_DISK_TYPE_UNSPECIFIED - これは不明なデータディスクタイプです。
- PD_SSD - SSD データディスク。
- PD_HDD - HDD データディスク。
- OBSOLETE_LOCAL_SSD - このフィールドは非推奨で、API の将来のバージョンで削除される予定です。
database_flags
タイプ: UNORDERED_LIST_STRUCT
プロバイダー名: databaseFlags
説明: 起動時にインスタンスに渡されるデータベースフラグ。
- name
  タイプ: STRING
  プロバイダー名: name
  説明: フラグの名前。これらのフラグはインスタンスの起動時に渡されるので、サーバーオプションとシステム変数の両方が含まれます。フラグはハイフンではなくアンダースコアで指定します。詳しくは、Cloud SQL ドキュメントのデータベースフラグの構成を参照してください。
- value
  タイプ: STRING
  プロバイダー名: value
  説明: フラグの値。ブール値のフラグは、true の場合は on に、false の場合は off に設定されます。フラグが値をとらない場合は、このフィールドを省略しなければなりません。
database_replication_enabled
タイプ: BOOLEAN
プロバイダー名: databaseReplicationEnabled
説明: リードレプリカインスタンスに特化した構成。レプリケーションが有効かどうかを示します。警告: これを変更すると、インスタンスが再起動します。
deletion_protection_enabled
タイプ: BOOLEAN
プロバイダー名: deletionProtectionEnabled
説明: 誤ってインスタンスが削除されないようにするための構成。
deny_maintenance_periods
タイプ: UNORDERED_LIST_STRUCT
プロバイダー名: denyMaintenancePeriods
説明: 拒否メンテナンス期間
- end_date
  タイプ: STRING
  プロバイダー名: endDate
  説明: “deny maintenance period” の終了日。終了日の年が空であれば、開始日の年も空でなければなりません。この場合、拒否メンテナンス期間が毎年繰り返されることを意味します。日付の形式は、yyyy-mm-dd (例: 2020-11-01)、または mm-dd (例: 11-01) です。
- start_date
  タイプ: STRING
  プロバイダー名: startDate
  説明: “deny maintenance period” の開始日。開始日の年が空であれば、終了日の年も空でなければなりません。この場合、拒否メンテナンス期間が毎年繰り返されることを意味します。日付の形式は、yyyy-mm-dd (例: 2020-11-01)、または mm-dd (例: 11-01) です。
- time
  タイプ: STRING
  プロバイダー名: time
  説明: “deny maintenance period” が start_date に始まり end_date に終了する UTC での時間。時刻の形式は HH:mm:SS、すなわち、00:00:00 です。
insights_config
タイプ: STRUCT
プロバイダー名: insightsConfig
説明: インサイト構成、今のところ Postgres にのみ関係します。
- query_insights_enabled
  タイプ: BOOLEAN
  プロバイダー名: queryInsightsEnabled
  説明: Query Insights 機能が有効かどうか。
- query_plans_per_minute
  タイプ: INT32
  プロバイダー名: queryPlansPerMinute
  説明: Insights が 1 分間にキャプチャした、すべてのクエリの実行プランの数。デフォルトは 5 です。
- query_string_length
  タイプ: INT32
  プロバイダー名: queryStringLength
  説明: 保存される最大クエリ長 (バイト単位)。デフォルト値: 1024 バイト。範囲: 256-4500 バイト。このフィールドの値以上のクエリ長は、この値に切り詰められます。未設定の場合、クエリ長はデフォルト値となります。クエリ長を変更すると、データベースを再起動します。
- record_application_tags
  タイプ: BOOLEAN
  プロバイダー名: recordApplicationTags
  説明: Query Insights が有効な場合に、クエリからアプリケーションタグを記録するかどうか。
- record_client_address
  タイプ: BOOLEAN
  プロバイダー名: recordClientAddress
  説明: Query Insights が有効な場合に、クライアントのアドレスを記録するかどうか。
ip_configuration
タイプ: STRUCT
プロバイダー名: ipConfiguration
説明: IP 管理に関する設定です。これにより、インスタンス IP を有効または無効にし、どの外部ネットワークがインスタンスに接続できるかを管理することができます。第二世代インスタンスでは、IPv4 アドレスを無効にすることはできません。
- allocated_ip_range
  タイプ: STRING
  プロバイダー名: allocatedIpRange
  説明: プライベート IP Cloud SQL インスタンスに割り当てられた IP 範囲の名前。例えば “google-managed-services-default” のようになります。設定した場合、インスタンス IP は割り当てられた範囲に作成されます。範囲名は RFC 1035 に準拠する必要があります。具体的には、1～63 文字で、正規表現 [a-z]([-a-z0-9]*[a-z0-9])?. にマッチする名前であることが必要です。
- authorized_networks
  タイプ: UNORDERED_LIST_STRUCT
  プロバイダー名: authorizedNetworks
  説明: IP を使用してインスタンスへの接続が許可されている外部ネットワークのリスト。‘CIDR’ 表記で、‘slash’ 表記としても知られています (例: 157.197.200.0/24)。
  - expiration_time
    タイプ: TIMESTAMP
    プロバイダー名: expirationTime
    説明: このアクセス制御エントリーの有効期限。RFC 3339 形式で、例えば 2012-11-15T16:19:00.094Z のようになります。
  - kind
    タイプ: STRING
    プロバイダー名: kind
    説明: これは常に sql#aclEntry です。
  - name
    タイプ: STRING
    プロバイダー名: name
    説明: オプション。このエントリーを識別するためのラベルです。
  - value
    タイプ: STRING
    プロバイダー名: value
    説明: アクセス制御リストの allowlisted 値。
- enable_private_path_for_google_cloud_services
  タイプ: BOOLEAN
  プロバイダー名: enablePrivatePathForGoogleCloudServices
  説明: BigQuery などの Google サービスからプライベート IP インスタンスへの接続を制御します。
- ipv4_enabled
  タイプ: BOOLEAN
  プロバイダー名: ipv4Enabled
  説明: インスタンスにパブリック IP アドレスが割り当てられているかどうか。
- private_network
  タイプ: STRING
  プロバイダー名: privateNetwork
  説明: Cloud SQL インスタンスがプライベート IP でアクセスできる VPC ネットワークのリソースリンク。例えば、/projects/myProject/global/networks/default となります。この設定は更新することができますが、設定後に削除することはできません。
- require_ssl
  タイプ: BOOLEAN
  プロバイダー名: requireSsl
  説明: IP 経由の SSL 接続が強制されるかどうか。
kind
タイプ: STRING
プロバイダー名: kind
説明: これは常に sql#settings です。
location_preference
タイプ: STRUCT
プロバイダー名: locationPreference
説明: ロケーションプリファレンスの設定。これにより、インスタンスは App Engine アプリまたは Compute Engine ゾーンのどちらかにできるだけ近い場所に配置され、パフォーマンスが向上します。App Engine のコロケーションは、第一世代のインスタンスにのみ適用されました。
- follow_gae_application
  タイプ: STRING
  プロバイダー名: followGaeApplication
  説明: フォローする App Engine アプリケーション。Cloud SQL インスタンスと同じリージョンにある必要があります。警告: これを変更すると、インスタンスが再起動する場合があります。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#locationPreference です。
- secondary_zone
  タイプ: STRING
  プロバイダー名: secondaryZone
  説明: セカンダリ/フェイルオーバーの優先 Compute Engine ゾーン (例: us-central1-a、us-central1-b など)。
- zone
  タイプ: STRING
  プロバイダー名: zone
  説明: 優先 Compute Engine ゾーン (例: us-central1-a、us-central1-b など)。警告: これを変更すると、インスタンスが再起動する場合があります。
maintenance_window
タイプ: STRUCT
プロバイダー名: maintenanceWindow
説明: このインスタンスのメンテナンスウィンドウ。これは、メンテナンスのためにインスタンスを再起動できるタイミングを指定します。
- day
  タイプ: INT32
  プロバイダー名: day
  説明: 曜日 (1-7)、月曜日から始まります。
- hour
  タイプ: INT32
  プロバイダー名: hour
  説明: 時間帯 - 0～23。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#maintenanceWindow です。
- update_track
  タイプ: STRING
  プロバイダー名: updateTrack
  説明: メンテナンスタイミングの設定: canary (初期) または stable (後期)。詳しくはこちら。
  可能な値:
  - SQL_UPDATE_TRACK_UNSPECIFIED - これは、不明なメンテナンスタイミングの優先です。
  - canary - 再起動が必要なインスタンス更新の場合、この更新追跡は、メンテナンスウィンドウの早い段階で新しいバージョンのために再起動することを好むインスタンスを示します。
  - stable - 再起動が必要なインスタンス更新の場合、この更新トラックは、Cloud SQL に再起動のタイミングを選択させることを希望するインスタンスを示します (該当する場合、そのメンテナンスウィンドウ内で)。
password_validation_policy
タイプ: STRUCT
プロバイダー名: passwordValidationPolicy
説明: インスタンスのローカルユーザーパスワード検証ポリシー。
- complexity
  タイプ: STRING
  プロバイダー名: complexity
  説明: パスワードの複雑さ。
  可能な値:
  - COMPLEXITY_UNSPECIFIED - 複雑さのチェックは指定されていません。
  - COMPLEXITY_DEFAULT - 小文字、大文字、数字、非英数字の組み合わせ。
- disallow_username_substring
  タイプ: BOOLEAN
  プロバイダー名: disallowUsernameSubstring
  説明: パスワードの一部としてのユーザー名を許可しません。
- enable_password_policy
  タイプ: BOOLEAN
  プロバイダー名: enablePasswordPolicy
  説明: パスワードポリシーが有効かどうか。
- min_length
  タイプ: INT32
  プロバイダー名: minLength
  説明: 最低限許可される文字数。
- password_change_interval
  タイプ: STRING
  プロバイダー名: passwordChangeInterval
  説明: パスワードを変更できるようになる最小間隔。このフラグは PostgreSQL でのみサポートされます。
- reuse_interval
  タイプ: INT32
  プロバイダー名: reuseInterval
  説明: 再利用できない過去のパスワードの数。
pricing_plan
タイプ: STRING
プロバイダー名: pricingPlan
説明: このインスタンスの料金プラン。これは PER_USE または PACKAGE のいずれかになります。第二世代インスタンスでは PER_USE のみがサポートされています。
可能な値:
- SQL_PRICING_PLAN_UNSPECIFIED - これは、このインスタンスの不明な料金プランです。
- PACKAGE - インスタンスは、月額定額制で請求されます。
- PER_USE - インスタンスは使用量ごとに請求されます。
replication_type
タイプ: STRING
プロバイダー名: replicationType
説明: このインスタンスが使用するレプリケーションのタイプ。これは ASYNCHRONOUS または SYNCHRONOUS のどちらかになります。(非推奨) このプロパティは、第一世代のインスタンスにのみ適用可能でした。
可能な値:
- SQL_REPLICATION_TYPE_UNSPECIFIED - これは、Cloud SQL インスタンスの不明なレプリケーションタイプです。
- SYNCHRONOUS - 第一世代インスタンスの同期レプリケーションモード。デフォルト値です。
- ASYNCHRONOUS - 第一世代インスタンスの非同期レプリケーションモード。若干のパフォーマンス向上が期待できますが、このオプションを非同期に設定した状態で障害が発生した場合、最大で数秒間のデータ更新が失われる可能性があります。
settings_version
タイプ: INT64
プロバイダー名: settingsVersion
説明: インスタンス設定のバージョン。これは、同時更新が適切に処理されるようにするための update メソッドの必須フィールドです。更新時には、このインスタンスの最新の settingsVersion 値を使用し、この値の更新は試みないでください。
sql_server_audit_config
タイプ: STRUCT
プロバイダー名: sqlServerAuditConfig
説明: SQL Server 固有の監査構成。
- bucket
  タイプ: STRING
  プロバイダー名: bucket
  説明: 宛先バケット名 (例: gs://mybucket)。
- kind
  タイプ: STRING
  プロバイダー名: kind
  説明: これは常に sql#sqlServerAuditConfig です
- retention_interval
  タイプ: STRING
  プロバイダー名: retentionInterval
  説明: 生成された監査ファイルの保存期間。
- upload_interval
  タイプ: STRING
  プロバイダー名: uploadInterval
  説明: 生成された監査ファイルをアップロードする頻度。
storage_auto_resize
タイプ: BOOLEAN
プロバイダー名: storageAutoResize
説明: ストレージサイズを自動的に増加させる構成。デフォルト値は true です。
storage_auto_resize_limit
タイプ: INT64
プロバイダー名: storageAutoResizeLimit
説明: ストレージの容量を自動的に増加させることができる最大サイズ。デフォルト値は 0 で、無制限であることを指定します。
tier
タイプ: STRING
プロバイダー名: tier
説明: このインスタンスの階層 (またはマシンタイプ)、たとえば db-custom-1-3840 です。警告: これを変更すると、インスタンスが再起動します。
time_zone
タイプ: STRING
プロバイダー名: timeZone
説明: サーバーのタイムゾーン。Cloud SQL for SQL Server のみに関連します。
user_labels
タイプ: UNORDERED_LIST_STRING
プロバイダー名: userLabels
説明: ユーザー提供のラベルで、各ラベルが 1 つのキーと値の組である辞書として表現されます。

`state`

タイプ: STRING
プロバイダー名: state
説明: Cloud SQL インスタンスの現在のサービス状態。
可能な値:

SQL_INSTANCE_STATE_UNSPECIFIED - インスタンスの状態は不明です。
RUNNABLE - インスタンスは実行中、またはオーナーによって停止されています。
SUSPENDED - 請求の問題などで、インスタンスは利用できません。
PENDING_DELETE - インスタンスは削除中です。
PENDING_CREATE - インスタンスは作成中です。
MAINTENANCE - インスタンスはメンテナンスのため停止しています。
FAILED - インスタンスの作成に失敗したか、メンテナンス中に致命的なエラーが発生しました。
ONLINE_MAINTENANCE - 非推奨

`suspension_reason`

タイプ: UNORDERED_LIST_STRING
プロバイダー名: suspensionReason
説明: インスタンス状態が SUSPENDED の場合、停止した理由。

`tags`

タイプ: UNORDERED_LIST_STRING