Gcp/alloydb
@swamp/gcp/alloydbv2026.07.31.1
01README
Google Cloud alloydb infrastructure models
02Release Notes
- Updated: clusters, supporteddatabaseflags
03Models
backups.tsv2026.07.29.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. |
| annotations? | record | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
| clusterName? | string | Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}). |
| description? | string | User-provided description of the backup. |
| displayName? | string | User-settable and human-readable display name for the Backup. |
| encryptionConfig? | object | The 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] |
| labels? | record | Labels as key value pairs |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ` "123/environment": "production", "123/costCenter": "marketing" ` |
| type? | enum | The backup type, which suggests the trigger for the backup. |
| backupId? | string | Required. ID of the requesting object. |
| requestId? | string | Optional. 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? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a backups
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
fn update(identifier?: string, waitForReady?: boolean)
Update backups attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific backups 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 backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
fn sync(identifier?: string)
Sync backups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific backups by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)
List backups resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filtering results |
| orderBy? | string | Hint for how to order the results |
| pageSize? | number | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| view? | string | Optional. The view of the backup to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
clusters.tsv2026.07.31.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. |
| annotations? | record | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
| automatedBackupPolicy? | object | The 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. |
| continuousBackupConfig? | object | Whether ContinuousBackup is enabled. |
| databaseVersion? | enum | Optional. 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? | object | Dataplex 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? | string | User-settable and human-readable display name for the Cluster. |
| encryptionConfig? | object | The 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] |
| initialUser? | object | The initial password for the user. |
| labels? | record | Labels as key value pairs |
| maintenanceUpdatePolicy? | object | Day 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? | enum | Input only. Policy to use to automatically select the maintenance version to which to update the cluster's instances. |
| networkConfig? | object | Optional. 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. |
| pscConfig? | object | Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance. |
| secondaryConfig? | object | The name of the primary cluster name with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} |
| sslConfig? | object | Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value. |
| subscriptionType? | enum | Optional. Subscription type of the cluster. |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ` "123/environment": "production", "123/costCenter": "marketing" ` |
| clusterId? | string | Required. ID of the requesting object. |
| requestId? | string | Optional. 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? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a clusters
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a clusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clusters |
fn update(identifier?: string, waitForReady?: boolean)
Update clusters attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific clusters 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 clusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clusters |
fn sync(identifier?: string)
Sync clusters state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific clusters by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List clusters resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filtering results |
| orderBy? | string | Optional. Hint for how to order the results |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn createsecondary(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)
createsecondary
| Argument | Type | Description |
|---|---|---|
| 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 |
fn export(csvExportOptions?: any, database?: any, gcsDestination?: any, sqlExportOptions?: any)
export
| Argument | Type | Description |
|---|---|---|
| csvExportOptions? | any | |
| database? | any | |
| gcsDestination? | any | |
| sqlExportOptions? | any |
fn import(csvImportOptions?: any, database?: any, gcsUri?: any, sqlImportOptions?: any, user?: any)
import
| Argument | Type | Description |
|---|---|---|
| csvImportOptions? | any | |
| database? | any | |
| gcsUri? | any | |
| sqlImportOptions? | any | |
| user? | any |
fn promote(etag?: any, requestId?: any, validateOnly?: any)
promote
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| requestId? | any | |
| validateOnly? | any |
fn restore(backupSource?: any, backupdrBackupSource?: any, backupdrPitrSource?: any, cluster?: any, clusterId?: any, continuousBackupSource?: any, requestId?: any, validateOnly?: any)
restore
| Argument | Type | Description |
|---|---|---|
| backupSource? | any | |
| backupdrBackupSource? | any | |
| backupdrPitrSource? | any | |
| cluster? | any | |
| clusterId? | any | |
| continuousBackupSource? | any | |
| requestId? | any | |
| validateOnly? | any |
fn restore_from_cloud_sql(cloudsqlBackupRunSource?: any, cluster?: any, clusterId?: any)
restore from cloud sql
| Argument | Type | Description |
|---|---|---|
| cloudsqlBackupRunSource? | any | |
| cluster? | any | |
| clusterId? | any |
fn switchover(requestId?: any, validateOnly?: any)
switchover
| Argument | Type | Description |
|---|---|---|
| requestId? | any | |
| validateOnly? | any |
fn upgrade(etag?: any, requestId?: any, validateOnly?: any, version?: any)
upgrade
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| requestId? | any | |
| validateOnly? | any | |
| version? | any |
clusters_instances.tsv2026.07.29.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. |
| activationPolicy? | enum | Optional. 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? | record | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
| availabilityType? | enum | Availability 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? | object | Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database. |
| connectionPoolConfig? | object | Output only. The number of running AuthProxy poolers per instance. |
| dataApiAccess? | enum | Optional. 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? | record | Database 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? | string | User-settable and human-readable display name for the Instance. |
| gceZone? | string | The 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? | enum | Required. The type of the instance. Specified at creation time. |
| labels? | record | Labels as key value pairs |
| machineConfig? | object | The number of CPU's in the VM instance. |
| networkConfig? | object | Optional. 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? | object | Observability feature status for an instance. This flag is turned "off" by default. |
| pscInstanceConfig? | object | Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. |
| queryInsightsConfig? | object | Number 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? | object | Read capacity, i.e. number of nodes in a read pool instance. |
| instanceId? | string | Required. ID of the requesting object. |
| requestId? | string | Optional. 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). |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
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, orderBy?: string, pageSize?: number, maxPages?: number)
List instances resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filtering results |
| orderBy? | string | Optional. Hint for how to order the results |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn createsecondary(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)
createsecondary
| Argument | Type | Description |
|---|---|---|
| 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 |
fn failover(requestId?: any, validateOnly?: any)
failover
| Argument | Type | Description |
|---|---|---|
| requestId? | any | |
| validateOnly? | any |
fn get_connection_info()
get connection info
fn inject_fault(faultType?: any, requestId?: any, validateOnly?: any)
inject fault
| Argument | Type | Description |
|---|---|---|
| faultType? | any | |
| requestId? | any | |
| validateOnly? | any |
fn restart(nodeIds?: any, requestId?: any, validateOnly?: any)
restart
| Argument | Type | Description |
|---|---|---|
| nodeIds? | any | |
| requestId? | any | |
| validateOnly? | any |
clusters_users.tsv2026.07.29.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. |
| databaseRoles? | array | Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
| keepExtraRoles? | boolean | Input only. If the user already exists and it has additional roles, keep them granted. |
| password? | string | Input only. Password for the user. |
| userType? | enum | Optional. Type of this user. |
| requestId? | string | Optional. 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? | string | Required. ID of the requesting object. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
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(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filtering results |
| orderBy? | string | Optional. Hint for how to order the results |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
locations.tsv2026.07.29.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. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
supporteddatabaseflags.tsv2026.07.31.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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a supportedDatabaseFlags
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the supportedDatabaseFlags |
fn sync(identifier?: string)
Sync supportedDatabaseFlags state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific supportedDatabaseFlags by name (e.g. one discovered by list) |
fn list(pageSize?: number, scope?: string, maxPages?: number)
List supportedDatabaseFlags resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| scope? | string | Optional. The scope for which supported flags are requested. If not specified, default is DATABASE. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
04Previous Versions
2026.07.29.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.07.21.4
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.07.21.1
- Updated: backups, clusters, clusters_instances, clusters_users
2026.07.20.2
- Updated: locations, clusters_instances
2026.07.20.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.07.18.2
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.07.17.2
- Updated: backups, clusters, clusters_instances, clusters_users
2026.07.17.1
- Updated: backups, clusters, clusters_instances, clusters_users
2026.07.10.1
- Updated: clusters_instances
2026.06.08.2
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.06.07.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.05.26.1
- Updated: locations, clusters_instances
2026.05.25.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
Modified 1 models
2026.05.24.1
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.05.21.2
- Updated: locations, backups, clusters, clusters_instances, clusters_users, supporteddatabaseflags
2026.05.21.1
2026.05.20.1
- Updated: clusters_instances
05Stats
A
100 / 100
Downloads
0
Archive size
108.0 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels