Skip to main content
← back to extensions

@swamp/gcp/alloydb

v2026.04.23.1

Google Cloud alloydb infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudalloydbcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

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/alloydb

clusters_instances.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
activationPolicy?enumOptional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
annotations?recordAnnotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
availabilityType?enumAvailability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).
clientConnectionConfig?objectOptional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
connectionPoolConfig?objectOptional. Whether to enable Managed Connection Pool (MCP).
dataApiAccess?enumOptional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well.
databaseFlags?recordDatabase flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn\'t take a value.
displayName?stringUser-settable and human-readable display name for the Instance.
gceZone?stringThe Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
instanceType?enumRequired. The type of the instance. Specified at creation time.
labels?recordLabels as key value pairs
machineConfig?objectThe number of CPU's in the VM instance.
networkConfig?objectOptional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
observabilityConfig?objectObservability feature status for an instance. This flag is turned "off" by default.
pscInstanceConfig?objectOptional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
queryInsightsConfig?objectNumber of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
readPoolConfig?objectRead capacity, i.e. number of nodes in a read pool instance.
writableNode?objectOutput only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
instanceId?stringRequired. ID of the requesting object.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a instances
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a instances
ArgumentTypeDescription
identifierstringThe name of the instances
updateUpdate instances attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the instances
ArgumentTypeDescription
identifierstringThe name of the instances
syncSync instances state from GCP
createsecondarycreatesecondary
ArgumentTypeDescription
activationPolicy?any
annotations?any
availabilityType?any
clientConnectionConfig?any
connectionPoolConfig?any
createTime?any
dataApiAccess?any
databaseFlags?any
deleteTime?any
displayName?any
etag?any
gceZone?any
instanceType?any
ipAddress?any
labels?any
machineConfig?any
maintenanceVersionName?any
name?any
networkConfig?any
nodes?any
observabilityConfig?any
outboundPublicIpAddresses?any
pscInstanceConfig?any
publicIpAddress?any
queryInsightsConfig?any
readPoolConfig?any
reconciling?any
satisfiesPzs?any
state?any
uid?any
updateTime?any
writableNode?any
failoverfailover
ArgumentTypeDescription
requestId?any
validateOnly?any
get_connection_infoget connection info
inject_faultinject fault
ArgumentTypeDescription
faultType?any
requestId?any
validateOnly?any
restartrestart
ArgumentTypeDescription
nodeIds?any
requestId?any
validateOnly?any
clusters_users.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
databaseRoles?arrayOptional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
keepExtraRoles?booleanInput only. If the user already exists and it has additional roles, keep them granted.
password?stringInput only. Password for the user.
userType?enumOptional. Type of this user.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
userId?stringRequired. ID of the requesting object.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a users
getGet a users
ArgumentTypeDescription
identifierstringThe name of the users
updateUpdate users attributes
deleteDelete the users
ArgumentTypeDescription
identifierstringThe name of the users
syncSync users state from GCP
clusters.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
annotations?recordAnnotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
automatedBackupPolicy?objectThe length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
backupSource?objectRequired. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}
backupdrBackupSource?objectRequired. The name of the backup resource with the format: * projects/{project}/locations/{location}/backupVaults/{backupvault_id}/dataSources/{datasource_id}/backups/{backup_id}
backupdrInfo?objectWhether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.
cloudsqlBackupRunSource?objectRequired. The CloudSQL backup run ID.
continuousBackupConfig?objectWhether ContinuousBackup is enabled.
continuousBackupInfo?objectOutput only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster\'s continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
databaseVersion?enumOptional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
dataplexConfig?objectDataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
displayName?stringUser-settable and human-readable display name for the Cluster.
encryptionConfig?objectThe fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
encryptionInfo?objectOutput only. Type of encryption.
initialUser?objectThe initial password for the user.
labels?recordLabels as key value pairs
maintenanceSchedule?objectOutput only. The scheduled start time for the maintenance.
maintenanceUpdatePolicy?objectDay of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
maintenanceVersionSelectionPolicy?enumInput only. Policy to use to automatically select the maintenance version to which to update the cluster's instances.
migrationSource?objectOutput only. The host and port of the on-premises instance in host:port format
networkConfig?objectOptional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. Field name is intended to be consistent with Cloud SQL.
primaryConfig?objectOutput only. Names of the clusters that are replicating from this cluster.
pscConfig?objectOptional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
secondaryConfig?objectThe name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}
sslConfig?objectOptional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
subscriptionType?enumOptional. Subscription type of the cluster.
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ` "123/environment": "production", "123/costCenter": "marketing" `
trialMetadata?objectEnd time of the trial cluster.
clusterId?stringRequired. ID of the requesting object.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a clusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
updateUpdate clusters attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the clusters
ArgumentTypeDescription
identifierstringThe name of the clusters
syncSync clusters state from GCP
createsecondarycreatesecondary
ArgumentTypeDescription
annotations?any
automatedBackupPolicy?any
backupSource?any
backupdrBackupSource?any
backupdrInfo?any
cloudsqlBackupRunSource?any
clusterType?any
continuousBackupConfig?any
continuousBackupInfo?any
createTime?any
databaseVersion?any
dataplexConfig?any
deleteTime?any
displayName?any
encryptionConfig?any
encryptionInfo?any
etag?any
initialUser?any
labels?any
maintenanceSchedule?any
maintenanceUpdatePolicy?any
maintenanceVersionSelectionPolicy?any
migrationSource?any
name?any
network?any
networkConfig?any
primaryConfig?any
pscConfig?any
reconciling?any
satisfiesPzs?any
secondaryConfig?any
sslConfig?any
state?any
subscriptionType?any
tags?any
trialMetadata?any
uid?any
updateTime?any
exportexport
ArgumentTypeDescription
csvExportOptions?any
database?any
gcsDestination?any
sqlExportOptions?any
importimport
ArgumentTypeDescription
csvImportOptions?any
database?any
gcsUri?any
sqlImportOptions?any
user?any
promotepromote
ArgumentTypeDescription
etag?any
requestId?any
validateOnly?any
restorerestore
ArgumentTypeDescription
backupSource?any
backupdrBackupSource?any
backupdrPitrSource?any
cluster?any
clusterId?any
continuousBackupSource?any
requestId?any
validateOnly?any
restore_from_cloud_sqlrestore from cloud sql
ArgumentTypeDescription
cloudsqlBackupRunSource?any
cluster?any
clusterId?any
switchoverswitchover
ArgumentTypeDescription
requestId?any
validateOnly?any
upgradeupgrade
ArgumentTypeDescription
etag?any
requestId?any
validateOnly?any
version?any
locations.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a locations
ArgumentTypeDescription
identifierstringThe name of the locations
syncSync locations state from GCP
backups.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
annotations?recordAnnotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
clusterName?stringRequired. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
description?stringUser-provided description of the backup.
displayName?stringUser-settable and human-readable display name for the Backup.
encryptionConfig?objectThe fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
encryptionInfo?objectOutput only. Type of encryption.
expiryQuantity?objectOutput only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
labels?recordLabels as key value pairs
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ` "123/environment": "production", "123/costCenter": "marketing" `
type?enumThe backup type, which suggests the trigger for the backup.
backupId?stringRequired. ID of the requesting object.
requestId?stringOptional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a backups
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a backups
ArgumentTypeDescription
identifierstringThe name of the backups
updateUpdate backups attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP
supporteddatabaseflags.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a supportedDatabaseFlags
ArgumentTypeDescription
identifierstringThe name of the supportedDatabaseFlags
syncSync supportedDatabaseFlags state from GCP