@swamp/gcp/sqladmin
v2026.04.23.1
Google Cloud sqladmin infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudsqladmincloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/sqladminsslcerts.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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. |
createCreate a sslCerts
getGet a sslCerts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sslCerts |
deleteDelete the sslCerts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sslCerts |
syncSync sslCerts state from GCP
create_ephemeralcreate ephemeral
| Argument | Type | Description |
|---|---|---|
| access_token? | any | |
| public_key? | any |
connect.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a connect
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connect |
syncSync connect state from GCP
generate_ephemeral_certgenerate ephemeral cert
| Argument | Type | Description |
|---|---|---|
| access_token? | any | |
| public_key? | any | |
| readTime? | any | |
| validDuration? | any |
users.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| sqlserverUserDetails? | object | 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. |
createCreate a users
getGet a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
updateUpdate users attributes
deleteDelete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
syncSync users state from GCP
backupruns.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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 | This is always `sql#diskEncryptionConfiguration`. |
| 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`. |
createCreate a backupRuns
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a backupRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the backupRuns |
deleteDelete the backupRuns
| Argument | Type | Description |
|---|---|---|
| identifier | string | The id of the backupRuns |
syncSync backupRuns state from GCP
tiers.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a tiers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tiers |
syncSync tiers state from GCP
instances.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| databaseVersion? | enum | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. |
| diskEncryptionConfiguration? | object | This is always `sql#diskEncryptionConfiguration`. |
| 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. |
| 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. |
createCreate a instances
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
updateUpdate instances attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the instances
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the instances |
syncSync instances state from GCP
acquire_ssrs_leaseacquire ssrs lease
| Argument | Type | Description |
|---|---|---|
| acquireSsrsLeaseContext? | any |
add_entra_id_certificateadd entra id certificate
add_server_caadd server ca
add_server_certificateadd server certificate
cloneclone
| Argument | Type | Description |
|---|---|---|
| cloneContext? | any |
demotedemote
| Argument | Type | Description |
|---|---|---|
| demoteContext? | any |
demote_masterdemote master
| Argument | Type | Description |
|---|---|---|
| demoteMasterContext? | any |
execute_sqlexecute sql
| Argument | Type | Description |
|---|---|---|
| application? | any | |
| autoIamAuthn? | any | |
| database? | any | |
| partialResultMode? | any | |
| rowLimit? | any | |
| sqlStatement? | any | |
| user? | any |
exportexport
| Argument | Type | Description |
|---|---|---|
| exportContext? | any |
failoverfailover
| Argument | Type | Description |
|---|---|---|
| failoverContext? | any |
importimport
| Argument | Type | Description |
|---|---|---|
| importContext? | any |
list_entra_id_certificateslist entra id certificates
list_server_caslist server cas
list_server_certificateslist server certificates
point_in_time_restorepoint 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 |
pre_check_major_version_upgradepre check major version upgrade
| Argument | Type | Description |
|---|---|---|
| preCheckMajorVersionUpgradeContext? | any |
promote_replicapromote replica
reencryptreencrypt
| Argument | Type | Description |
|---|---|---|
| backupReencryptionConfig? | any |
release_ssrs_leaserelease ssrs lease
reset_ssl_configreset ssl config
restartrestart
restore_backuprestore backup
| Argument | Type | Description |
|---|---|---|
| backup? | any | |
| backupdrBackup? | any | |
| restoreBackupContext? | any | |
| restoreInstanceClearOverridesFieldNames? | any | |
| restoreInstanceSettings? | any |
rotate_entra_id_certificaterotate entra id certificate
| Argument | Type | Description |
|---|---|---|
| rotateEntraIdCertificateContext? | any |
rotate_server_carotate server ca
| Argument | Type | Description |
|---|---|---|
| rotateServerCaContext? | any |
rotate_server_certificaterotate server certificate
| Argument | Type | Description |
|---|---|---|
| rotateServerCertificateContext? | any |
start_replicastart replica
stop_replicastop replica
switchoverswitchover
truncate_logtruncate log
| Argument | Type | Description |
|---|---|---|
| truncateLogContext? | any |
databases.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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 |
createCreate a databases
getGet a databases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databases |
updateUpdate databases attributes
deleteDelete the databases
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the databases |
syncSync databases state from GCP
flags.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a flags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the flags |
syncSync flags state from GCP
2026.04.04.185.1 KBApr 4, 2026
Google Cloud sqladmin infrastructure models
Release Notes
- Updated: instances
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudsqladmincloudinfrastructure
2026.04.03.384.8 KBApr 3, 2026
Google Cloud sqladmin infrastructure models
Release Notes
- Updated: backupruns, connect, databases, flags, instances, sslcerts, tiers, users
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudsqladmincloudinfrastructure
2026.04.03.184.3 KBApr 3, 2026
Google Cloud sqladmin infrastructure models
Release Notes
- Updated: backupruns, connect, databases, flags, instances, sslcerts, tiers, users
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudsqladmincloudinfrastructure
2026.04.02.284.3 KBApr 2, 2026
Google Cloud sqladmin infrastructure models
Release Notes
- Updated: instances
Changelog
Models
~methods: -update
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudsqladmincloudinfrastructure
2026.03.27.183.0 KBMar 27, 2026
Google Cloud sqladmin infrastructure models
Release Notes
- Added: backupruns, connect, databases, flags, instances, sslcerts, tiers, users
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudsqladmincloudinfrastructure