Gcp/redis
@swamp/gcp/redisv2026.07.24.1
01README
Google Cloud redis infrastructure models
02Release Notes
- Added: aclpolicies_revisions
- Updated: aclpolicies, clusters
03Models
aclpolicies.tsv2026.07.24.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. |
| name? | string | Identifier. Full resource path of the ACL policy. |
| rules? | array | Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Redis OSS: https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/ |
| aclPolicyId? | string | Required. The logical name of the ACL policy in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location |
| requestId? | string | Optional. Idempotent request UUID.. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a aclPolicies
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a aclPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aclPolicies |
fn update(identifier?: string, waitForReady?: boolean)
Update aclPolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific aclPolicies 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 aclPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the aclPolicies |
fn sync(identifier?: string)
Sync aclPolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific aclPolicies by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List aclPolicies resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more ACL policies left to be queried. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
aclpolicies_revisions.tsv2026.07.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. |
| 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 get(identifier: string)
Get a revisions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the revisions |
fn sync(identifier?: string)
Sync revisions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific revisions by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List revisions resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of items to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
backupcollections.tsv2026.07.21.2
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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a backupCollections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backupCollections |
fn sync(identifier?: string)
Sync backupCollections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific backupCollections by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List backupCollections resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
backupcollections_backups.tsv2026.07.21.2
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. |
| 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 get(identifier: string)
Get a backups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the backups |
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(pageSize?: number, maxPages?: number)
List backups resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn export(gcsBucket?: any)
export
| Argument | Type | Description |
|---|---|---|
| gcsBucket? | any |
clusters.tsv2026.07.24.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. |
| aclPolicy? | string | Optional. The ACL policy to be applied to the cluster. |
| asyncClusterEndpointsDeletionEnabled? | boolean | Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted. |
| authorizationMode? | enum | Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. |
| automatedBackupConfig? | object | Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored. |
| clusterEndpoints? | array | Output only. The IP allocated on the consumer network for the PSC forwarding rule. |
| crossClusterReplicationConfig? | object | Output only. The role of the cluster in cross cluster replication. |
| deletionProtectionEnabled? | boolean | Optional. The delete operation will fail when the value is set to true. |
| gcsSource? | object | Optional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2 |
| kmsKey? | string | Optional. The KMS key used to encrypt the at-rest data of the cluster. |
| labels? | record | Optional. Labels to represent user-provided metadata. |
| maintenancePolicy? | object | Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. |
| maintenanceVersion? | string | Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field. |
| managedBackupSource? | object | Optional. Example: //redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} A shorter version (without the prefix) of the backup name is also supported, like projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup_id} In this case, it assumes the backup is under redis.googleapis.com. |
| name? | string | Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` |
| nodeType? | enum | Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. |
| persistenceConfig? | object | Optional. fsync configuration. |
| pscConfigs? | array | Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. |
| redisConfigs? | record | Optional. Key/Value pairs of customer overrides for mutable Redis Configs |
| replicaCount? | number | Optional. The number of replica nodes per shard. |
| rotateServerCertificate? | boolean | Optional. Input only. Rotate the server certificates. |
| serverCaMode? | enum | Optional. Server CA mode for the cluster. |
| serverCaPool? | string | Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}". |
| shardCount? | number | Optional. Number of shards for the Redis cluster. |
| simulateMaintenanceEvent? | boolean | Optional. Input only. Simulate a maintenance event. |
| transitEncryptionMode? | enum | Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. |
| zoneDistributionConfig? | object | Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. |
| clusterId? | string | Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location |
| requestId? | string | Optional. Idempotent request UUID. |
| 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(pageSize?: number, maxPages?: number)
List clusters resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_token_auth_user(tokenAuthUser?: any)
add token auth user
| Argument | Type | Description |
|---|---|---|
| tokenAuthUser? | any |
fn backup(backupId?: any, ttl?: any)
backup
| Argument | Type | Description |
|---|---|---|
| backupId? | any | |
| ttl? | any |
fn get_certificate_authority()
get certificate authority
fn reschedule_cluster_maintenance(rescheduleType?: any, scheduleTime?: any)
reschedule cluster maintenance
| Argument | Type | Description |
|---|---|---|
| rescheduleType? | any | |
| scheduleTime? | any |
clusters_tokenauthusers.tsv2026.07.21.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. |
| 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 get(identifier: string)
Get a tokenAuthUsers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tokenAuthUsers |
fn delete(identifier: string)
Delete the tokenAuthUsers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tokenAuthUsers |
fn sync(identifier?: string)
Sync tokenAuthUsers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tokenAuthUsers by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tokenAuthUsers resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Expression for filtering results. |
| orderBy? | string | Optional. Sort results by a defined order. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_auth_token(authToken?: any)
add auth token
| Argument | Type | Description |
|---|---|---|
| authToken? | any |
clusters_tokenauthusers_authtokens.tsv2026.07.21.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. |
| 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 get(identifier: string)
Get a authTokens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the authTokens |
fn delete(identifier: string)
Delete the authTokens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the authTokens |
fn sync(identifier?: string)
Sync authTokens state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific authTokens by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List authTokens resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Expression for filtering results. |
| orderBy? | string | Optional. Sort results by a defined order. |
| pageSize? | number | Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
instances.tsv2026.07.21.3
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. |
| alternativeLocationId? | string | Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. |
| authEnabled? | boolean | Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. |
| authorizedNetwork? | string | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used. |
| availableMaintenanceVersions? | array | Optional. The available maintenance versions that an instance could update to. |
| connectMode? | enum | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. |
| customerManagedKey? | string | Optional. The KMS key reference that the customer provides when trying to create the instance. |
| displayName? | string | An arbitrary and optional user-provided name for the instance. |
| labels? | record | Resource labels to represent user provided metadata |
| locationId? | string | Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. |
| maintenancePolicy? | object | Output only. The time when the policy was created. |
| maintenanceVersion? | string | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". |
| memorySizeGb? | number | Required. Redis memory size in GiB. |
| name? | string | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. |
| persistenceConfig? | object | Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used. |
| readReplicasMode? | enum | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. |
| redisConfigs? | record | Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries |
| redisVersion? | string | Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility |
| replicaCount? | number | Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. |
| reservedIpRange? | string | Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. |
| secondaryIpRange? | string | Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". |
| suspensionReasons? | array | Optional. reasons that causes instance in "SUSPENDED" state. |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" |
| tier? | enum | Required. The service tier of the instance. |
| transitEncryptionMode? | enum | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. |
| instanceId? | string | Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location |
| 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(pageSize?: number, maxPages?: number)
List instances resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn export(outputConfig?: any)
export
| Argument | Type | Description |
|---|---|---|
| outputConfig? | any |
fn failover(dataProtectionMode?: any)
failover
| Argument | Type | Description |
|---|---|---|
| dataProtectionMode? | any |
fn get_auth_string()
get auth string
fn import(inputConfig?: any)
import
| Argument | Type | Description |
|---|---|---|
| inputConfig? | any |
fn reschedule_maintenance(rescheduleType?: any, scheduleTime?: any)
reschedule maintenance
| Argument | Type | Description |
|---|---|---|
| rescheduleType? | any | |
| scheduleTime? | any |
fn upgrade(redisVersion?: any)
upgrade
| Argument | Type | Description |
|---|---|---|
| redisVersion? | any |
locations.tsv2026.07.21.3
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. |
| 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) |
fn get_shared_regional_certificate_authority()
get shared regional certificate authority
04Previous Versions
2026.07.21.4
- Added: clusters_tokenauthusers, clusters_tokenauthusers_authtokens
- Updated: locations, aclpolicies, clusters
2026.07.21.1
- Updated: clusters, instances
2026.07.20.2
- Added: clusters_tokenauthusers, clusters_tokenauthusers_authtokens
- Updated: locations, aclpolicies, clusters
2026.07.20.1
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, instances
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.07.18.2
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.07.17.2
- Updated: aclpolicies, clusters, instances
2026.07.17.1
- Updated: aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.06.24.1
- Updated: aclpolicies, clusters
2026.06.08.2
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.06.07.1
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.05.26.1
- Added: clusters_tokenauthusers, clusters_tokenauthusers_authtokens
- Updated: locations, clusters
2026.05.25.1
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, instances
Modified 1 models
2026.05.24.1
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.05.21.2
- Updated: locations, aclpolicies, backupcollections, backupcollections_backups, clusters, clusters_tokenauthusers, clusters_tokenauthusers_authtokens, instances
2026.05.21.1
2026.05.20.1
- Added: clusters_tokenauthusers, clusters_tokenauthusers_authtokens
- Updated: clusters
2026.05.19.2
05Stats
A
100 / 100
Downloads
0
Archive size
109.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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels