Gcp/sqladmin
@swamp/gcp/sqladminv2026.10.24.1
01README
Google Cloud sqladmin infrastructure models
02Release Notes
- Updated: workloadcaptures
03Behaviors
backupruns.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| backupKind? | enum | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. |
| description? | string | The description of this run, only applicable to on-demand backups. |
| diskEncryptionConfiguration? | object | Optional. Whether to enforce CMEK log encryption at source. When enforced, transaction logs are encrypted prior to being uploaded to Cloud Storage. If not enforced, then CMEK logs are encrypted by the Cloud Storage service. |
| diskEncryptionStatus? | object | This is always `sql#diskEncryptionStatus`. |
| endTime? | string | The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. |
| enqueuedTime? | string | The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. |
| error? | object | Identifies the specific error that occurred. |
| id? | string | The identifier for this backup run. Unique only for a specific Cloud SQL instance. |
| instance? | string | Name of the database instance. |
| location? | string | Location of the backups. |
| startTime? | string | The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. |
| status? | enum | The status of this run. |
| timeZone? | string | Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. |
| type? | enum | The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. |
| windowStartTime? | string | The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. |
fn create(waitForReady?: boolean)
Create a backupRuns
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a backupRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the backupRuns |
fn delete(identifier: string)
Delete the backupRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the backupRuns |
fn sync(identifier?: string)
Sync backupRuns state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific backupRuns by id (e.g. one discovered by list) |
fn list(maxResults?: number, maxPages?: number)
List backupRuns resources
| Argument | Type | Description |
|---|---|---|
| maxResults? | number | Maximum number of backup runs per response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A BackupRun resource.
bluegreendeployments.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| description? | string | Optional. User-provided description for the deployment. The description can be up to 255 characters long. |
| requestedConfig? | object | Optional. The target database major version for the upgrade. For example, `MYSQL_8_0` or `POSTGRES_15`. |
| sourceInstance? | string | Required. Immutable. Required on create, and immutable. The full resource name of the source instance (the "blue" instance). Format: projects/{project}/instances/{instance} |
| blueGreenDeploymentId? | string | Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name. The ID must be unique within the given project and location and between 2-63 characters. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a blueGreenDeployments
fn get(identifier: string)
Get a blueGreenDeployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the blueGreenDeployments |
fn delete(identifier: string)
Delete the blueGreenDeployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the blueGreenDeployments |
fn sync(identifier?: string)
Sync blueGreenDeployments state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific blueGreenDeployments by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List blueGreenDeployments resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter expression that filters the results. |
| orderBy? | string | Optional. A comma-separated list of fields to order the results by. |
| pageSize? | number | Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn switchover()
switchover
Resources
state(infinite)— A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment...
connect.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a connect
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connect |
fn sync(identifier?: string)
Sync connect state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific connect by name (e.g. one discovered by list) |
fn generate_ephemeral_cert(access_token?: any, public_key?: any, readTime?: any, validDuration?: any)
generate ephemeral cert
| Argument | Type | Description |
|---|---|---|
| access_token? | any | |
| public_key? | any | |
| readTime? | any | |
| validDuration? | any |
fn resolve()
resolve
Resources
state(infinite)— Connect settings retrieval response.
databases.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| charset? | string | The Cloud SQL charset value. |
| collation? | string | The Cloud SQL collation value. |
| instance? | string | The name of the Cloud SQL instance. This does not include the project ID. |
| name? | string | The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. |
| project? | string | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. |
| sqlserverDatabaseDetails? | object | The version of SQL Server with which the database is to be made compatible |
| location? | string | Optional. Region of the Cloud SQL instance. |
fn create()
Create a databases
fn get(identifier: string)
Get a databases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databases |
fn update(identifier?: string)
Update databases attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific databases by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the databases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databases |
fn sync(identifier?: string)
Sync databases state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific databases by name (e.g. one discovered by list) |
fn list(location?: string, maxPages?: number)
List databases resources
| Argument | Type | Description |
|---|---|---|
| location? | string | Optional. Region of the Cloud SQL instance. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Represents a SQL database on the Cloud SQL instance.
flags.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a flags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the flags |
fn sync(identifier?: string)
Sync flags state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific flags by name (e.g. one discovered by list) |
fn list(databaseVersion?: string, flagScope?: string, maxPages?: number)
List flags resources
| Argument | Type | Description |
|---|---|---|
| databaseVersion? | string | Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions. |
| flagScope? | string | Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A flag resource.
instances.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| backendType? | enum | 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 | Connection name of the Cloud SQL instance used in connection strings. |
| databaseCenterIntegration? | enum | Optional. State of the Database Center integration for this instance. When unspecified, Database Center integration is enabled by default. |
| databaseCenterIntegrationEnabled? | boolean | Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. |
| databaseVersion? | enum | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. |
| diskEncryptionConfiguration? | object | Optional. Whether to enforce CMEK log encryption at source. When enforced, transaction logs are encrypted prior to being uploaded to Cloud Storage. If not enforced, then CMEK logs are encrypted by the Cloud Storage service. |
| diskEncryptionStatus? | object | This is always `sql#diskEncryptionStatus`. |
| failoverReplica? | object | The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true. |
| gceZone? | string | 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? | object | Output only. Whether the active query is enabled. |
| includeReplicasForMajorVersionUpgrade? | boolean | Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. |
| instanceType? | enum | The instance type. |
| ipAddresses? | array | The IP address assigned. |
| maintenanceVersion? | string | The current software version on the instance. |
| masterInstanceName? | string | The name of the instance which will act as primary in the replication setup. |
| name? | string | Name of the Cloud SQL instance. This does not include the project ID. |
| nodeCount? | number | The number of read pool nodes in a read pool. |
| onPremisesConfiguration? | object | PEM representation of the trusted CA's x509 certificate. |
| outOfDiskReport? | object | The minimum recommended increase size in GigaBytes This field is consumed by the frontend * Writers: * the proactive database wellness job for OOD. * Readers: |
| project? | string | The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. |
| region? | string | The geographical region of the Cloud SQL instance. It can be one of the [regions](https://cloud.google.com/sql/docs/mysql/locations#location-r) where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and `us-central1`. The default value is `us-central1`. |
| replicaConfiguration? | object | Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. |
| replicaNames? | array | The replicas of the instance. |
| replicationCluster? | object | Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance. |
| rootPassword? | string | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. |
| satisfiesPzs? | boolean | This status indicates whether the instance satisfies PZS. The status is reserved for future use. |
| scheduledMaintenance? | object | If the scheduled maintenance can be rescheduled. |
| secondaryGceZone? | string | 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. |
| serverCaCert? | object | PEM representation. |
| serviceAccountEmailAddress? | string | The service account email address assigned to the instance.\\This property is read-only. |
| settings? | object | Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect. |
| skipPrecheck? | boolean | Optional. Input only. Determines whether the precheck step is skipped during a major version upgrade. |
| sqlNetworkArchitecture? | enum | |
| state? | enum | The current serving state of the Cloud SQL instance. |
| suspensionReason? | array | If the instance state is SUSPENDED, the reason for the suspension. |
| switchTransactionLogsToCloudStorageEnabled? | boolean | Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. |
| tags? | record | Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: `"": ""`. For example, a single resource can have the following tags: ` "123/environment": "production", "123/costCenter": "marketing", ` For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
| location? | string | Optional. Region of the Cloud SQL instance. |
| reconcilePscNetworking? | string | Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking. |
| reconcilePscNetworkingForce? | string | Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking. |
fn create(waitForReady?: boolean)
Create a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
fn update(identifier?: string, waitForReady?: boolean)
Update instances attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific instances by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
fn sync(identifier?: string)
Sync instances state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific instances by name (e.g. one discovered by list) |
fn list(filter?: string, location?: string, maxResults?: number, maxPages?: number)
List instances resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. |
| location? | string | Optional. Region of the Cloud SQL instance. |
| maxResults? | number | The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn acquire_ssrs_lease(acquireSsrsLeaseContext?: any, location?: any)
acquire ssrs lease
| Argument | Type | Description |
|---|---|---|
| acquireSsrsLeaseContext? | any | |
| location? | any |
fn add_entra_id_certificate(location?: any)
add entra id certificate
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn add_server_ca(location?: any)
add server ca
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn add_server_certificate(location?: any)
add server certificate
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn clone(cloneContext?: any, location?: any)
clone
| Argument | Type | Description |
|---|---|---|
| cloneContext? | any | |
| location? | any |
fn demote(demoteContext?: any, location?: any)
demote
| Argument | Type | Description |
|---|---|---|
| demoteContext? | any | |
| location? | any |
fn demote_master(demoteMasterContext?: any, location?: any)
demote master
| Argument | Type | Description |
|---|---|---|
| demoteMasterContext? | any | |
| location? | any |
fn execute_sql(application?: any, autoIamAuthn?: any, database?: any, partialResultMode?: any, passwordSecretVersion?: any, rowLimit?: any, sqlStatement?: any, user?: any, location?: any)
execute sql
| Argument | Type | Description |
|---|---|---|
| application? | any | |
| autoIamAuthn? | any | |
| database? | any | |
| partialResultMode? | any | |
| passwordSecretVersion? | any | |
| rowLimit? | any | |
| sqlStatement? | any | |
| user? | any | |
| location? | any |
fn export(exportContext?: any, location?: any)
export
| Argument | Type | Description |
|---|---|---|
| exportContext? | any | |
| location? | any |
fn failover(failoverContext?: any, location?: any)
failover
| Argument | Type | Description |
|---|---|---|
| failoverContext? | any | |
| location? | any |
fn import(importContext?: any, location?: any)
import
| Argument | Type | Description |
|---|---|---|
| importContext? | any | |
| location? | any |
fn list_entra_id_certificates(location?: any)
list entra id certificates
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn list_server_cas(location?: any)
list server cas
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn list_server_certificates(location?: any)
list server certificates
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn point_in_time_restore(allocatedIpRange?: any, datasource?: any, pointInTime?: any, preferredSecondaryZone?: any, preferredZone?: any, privateNetwork?: any, region?: any, targetInstance?: any, targetInstanceClearSettingsFieldNames?: any, targetInstanceSettings?: any)
point in time restore
| Argument | Type | Description |
|---|---|---|
| allocatedIpRange? | any | |
| datasource? | any | |
| pointInTime? | any | |
| preferredSecondaryZone? | any | |
| preferredZone? | any | |
| privateNetwork? | any | |
| region? | any | |
| targetInstance? | any | |
| targetInstanceClearSettingsFieldNames? | any | |
| targetInstanceSettings? | any |
fn pre_check_major_version_upgrade(preCheckMajorVersionUpgradeContext?: any, location?: any)
pre check major version upgrade
| Argument | Type | Description |
|---|---|---|
| preCheckMajorVersionUpgradeContext? | any | |
| location? | any |
fn promote_replica(failover?: any, location?: any)
promote replica
| Argument | Type | Description |
|---|---|---|
| failover? | any | |
| location? | any |
fn reencrypt(backupReencryptionConfig?: any, location?: any)
reencrypt
| Argument | Type | Description |
|---|---|---|
| backupReencryptionConfig? | any | |
| location? | any |
fn release_ssrs_lease(location?: any)
release ssrs lease
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn reset_ssl_config(location?: any, mode?: any)
reset ssl config
| Argument | Type | Description |
|---|---|---|
| location? | any | |
| mode? | any |
fn restart(location?: any)
restart
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn restore_backup(backup?: any, backupdrBackup?: any, ignoreMaintenanceVersion?: any, restoreBackupContext?: any, restoreInstanceClearOverridesFieldNames?: any, restoreInstanceSettings?: any, location?: any)
restore backup
| Argument | Type | Description |
|---|---|---|
| backup? | any | |
| backupdrBackup? | any | |
| ignoreMaintenanceVersion? | any | |
| restoreBackupContext? | any | |
| restoreInstanceClearOverridesFieldNames? | any | |
| restoreInstanceSettings? | any | |
| location? | any |
fn rotate_entra_id_certificate(rotateEntraIdCertificateContext?: any, location?: any)
rotate entra id certificate
| Argument | Type | Description |
|---|---|---|
| rotateEntraIdCertificateContext? | any | |
| location? | any |
fn rotate_server_ca(rotateServerCaContext?: any, location?: any)
rotate server ca
| Argument | Type | Description |
|---|---|---|
| rotateServerCaContext? | any | |
| location? | any |
fn rotate_server_certificate(rotateServerCertificateContext?: any, location?: any)
rotate server certificate
| Argument | Type | Description |
|---|---|---|
| rotateServerCertificateContext? | any | |
| location? | any |
fn start_replica(location?: any)
start replica
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn stop_replica(location?: any)
stop replica
| Argument | Type | Description |
|---|---|---|
| location? | any |
fn switchover(dbTimeout?: any, location?: any)
switchover
| Argument | Type | Description |
|---|---|---|
| dbTimeout? | any | |
| location? | any |
fn truncate_log(truncateLogContext?: any, location?: any)
truncate log
| Argument | Type | Description |
|---|---|---|
| truncateLogContext? | any | |
| location? | any |
Resources
state(infinite)— A Cloud SQL instance resource.
sslcerts.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| commonName? | string | User supplied name. Must be a distinct name from the other certificates for this instance. |
| instance | string | Cloud SQL instance ID. This does not include the project ID. |
fn create()
Create a sslCerts
fn get(identifier: string)
Get a sslCerts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sslCerts |
fn delete(identifier: string)
Delete the sslCerts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sslCerts |
fn sync(identifier?: string)
Sync sslCerts state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sslCerts by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List sslCerts resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn create_ephemeral(access_token?: any, public_key?: any, location?: any)
create ephemeral
| Argument | Type | Description |
|---|---|---|
| access_token? | any | |
| public_key? | any | |
| location? | any |
Resources
state(infinite)— SslCerts Resource
tiers.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a tiers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tiers |
fn sync(identifier?: string)
Sync tiers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tiers by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List tiers resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Google Cloud SQL service tier resource.
users.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| databaseRoles? | array | Optional. Role memberships of the user |
| dualPasswordType? | enum | Dual password status for the user. |
| host? | string | Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. |
| iamEmail? | string | Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users. |
| iamStatus? | enum | Indicates if a group is active or inactive for IAM database authentication. |
| instance? | string | The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. |
| name? | string | The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL. |
| password? | string | The password for the user. |
| passwordPolicy? | object | Number of failed login attempts allowed before user get locked. |
| project? | string | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. |
| serverRoles? | array | Optional. The server roles for the SQL Server login. |
| sqlserverUserDetails? | object | Indicates if the user has been disabled. |
| type? | enum | The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. |
| location? | string | Optional. Region of the Cloud SQL instance. |
| revokeExistingRoles? | string | Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles. |
| revokeExistingServerRoles? | string | Optional. Specifies whether to revoke existing roles that are not present in the `server_roles` field. If `false` or unset, the server roles specified in `server_roles` are added to the user's existing server roles. |
fn create()
Create a users
fn get(identifier: string)
Get a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn update(identifier?: string)
Update users attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync(identifier?: string)
Sync users state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn list(location?: string, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| location? | string | Optional. Region of the Cloud SQL instance. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Cloud SQL user resource.
workloadcaptures.tsv2026.10.24.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| instance | string | Required. Cloud SQL instance ID. This does not include the project ID. |
fn get(identifier: string)
Get a workloadCaptures
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workloadCaptures |
fn sync(identifier?: string)
Sync workloadCaptures state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workloadCaptures by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List workloadCaptures resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn start(startWorkloadCaptureContext?: any)
start
| Argument | Type | Description |
|---|---|---|
| startWorkloadCaptureContext? | any |
fn start_replay(startWorkloadReplayContext?: any)
start replay
| Argument | Type | Description |
|---|---|---|
| startWorkloadReplayContext? | any |
fn stop(stopWorkloadCaptureContext?: any)
stop
| Argument | Type | Description |
|---|---|---|
| stopWorkloadCaptureContext? | any |
fn stop_replay(stopWorkloadReplayContext?: any)
stop replay
| Argument | Type | Description |
|---|---|---|
| stopWorkloadReplayContext? | any |
Resources
state(infinite)— Captured workload for an instance.
04Previous Versions
2026.10.23.2AGPL-3.0-or-later
- Updated: backupruns, bluegreendeployments, connect, databases, flags, instances, sslcerts, tiers, users, workloadcaptures
2026.10.23.1AGPL-3.0-or-later
- Updated: workloadcaptures
2026.10.21.1AGPL-3.0-or-later
- Updated: workloadcaptures
2026.10.14.1AGPL-3.0-or-later(was none)
- Updated: instances, workloadcaptures
2026.10.13.1
- Updated: backupruns, bluegreendeployments, connect, databases, flags, instances, sslcerts, tiers, users, workloadcaptures
2026.10.06.1
- Updated: connect, databases, instances, sslcerts, users, workloadcaptures
2026.09.29.1
- Updated: databases, instances
2026.09.20.1
- Added: workloadcaptures
- Updated: backupruns, instances
Modified 1 behaviors
2026.09.18.1
- Updated: backupruns, instances
Modified 1 behaviors
2026.09.17.1
- Added: workloadcaptures
- Updated: backupruns, instances
Modified 1 behaviors
2026.09.07.1
- Updated: instances, sslcerts, users
2026.08.29.1
- Added: bluegreendeployments
- Updated: backupruns, databases, instances, sslcerts, users
2026.08.12.3
- Updated: users
2026.08.12.2
- Updated: backupruns, connect, databases, flags, instances, sslcerts, tiers, users
2026.08.03.1
- Updated: instances, users
2026.07.29.1
- Updated: backupruns, connect, databases, flags, instances, sslcerts, tiers, users
2026.07.21.4
- Updated: connect, instances, users
2026.07.21.1
- Updated: backupruns, instances, sslcerts, users
2026.07.20.2
- Updated: connect, instances, users
05Stats
A
100 / 100
Downloads
254
Archive size
148.9 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels