Skip to main content
← back to extensions

@swamp/gcp/redis

v2026.04.23.1

Google Cloud redis infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudrediscloudinfrastructure

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

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
get_shared_regional_certificate_authorityget shared regional certificate authority
backupcollections.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 backupCollections
ArgumentTypeDescription
identifierstringThe name of the backupCollections
syncSync backupCollections state from GCP
clusters_tokenauthusers.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 tokenAuthUsers
ArgumentTypeDescription
identifierstringThe name of the tokenAuthUsers
deleteDelete the tokenAuthUsers
ArgumentTypeDescription
identifierstringThe name of the tokenAuthUsers
syncSync tokenAuthUsers state from GCP
add_auth_tokenadd auth token
ArgumentTypeDescription
authToken?any
clusters.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
aclPolicy?stringOptional. The ACL policy to be applied to the cluster.
asyncClusterEndpointsDeletionEnabled?booleanOptional. 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?enumOptional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
automatedBackupConfig?objectOptional. The automated backup mode. If the mode is disabled, the other fields will be ignored.
clusterEndpoints?arrayOutput only. The IP allocated on the consumer network for the PSC forwarding rule.
crossClusterReplicationConfig?objectOutput only. The role of the cluster in cross cluster replication.
deletionProtectionEnabled?booleanOptional. The delete operation will fail when the value is set to true.
encryptionInfo?objectOutput only. Type of encryption.
gcsSource?objectOptional. URIs of the Cloud Storage objects to import. Example: gs://bucket1/object1, gs://bucket2/folder2/object2
kmsKey?stringOptional. The KMS key used to encrypt the at-rest data of the cluster.
labels?recordOptional. Labels to represent user-provided metadata.
maintenancePolicy?objectOutput only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned.
maintenanceSchedule?objectOutput only. The end time of any upcoming scheduled maintenance for this instance.
maintenanceVersion?stringOptional. 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?objectOptional. 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?stringRequired. 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?enumOptional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
persistenceConfig?objectOptional. fsync configuration.
pscConfigs?arrayRequired. 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?recordOptional. Key/Value pairs of customer overrides for mutable Redis Configs
replicaCount?numberOptional. The number of replica nodes per shard.
rotateServerCertificate?booleanOptional. Input only. Rotate the server certificates.
serverCaMode?enumOptional. Server CA mode for the cluster.
serverCaPool?stringOptional. 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?numberOptional. Number of shards for the Redis cluster.
simulateMaintenanceEvent?booleanOptional. Input only. Simulate a maintenance event.
stateInfo?objectTarget node type for redis cluster.
transitEncryptionMode?enumOptional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
zoneDistributionConfig?objectOptional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified.
clusterId?stringRequired. 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?stringOptional. Idempotent request UUID.
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
add_token_auth_useradd token auth user
ArgumentTypeDescription
tokenAuthUser?any
backupbackup
ArgumentTypeDescription
backupId?any
ttl?any
get_certificate_authorityget certificate authority
reschedule_cluster_maintenancereschedule cluster maintenance
ArgumentTypeDescription
rescheduleType?any
scheduleTime?any
instances.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
alternativeLocationId?stringOptional. 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?booleanOptional. 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?stringOptional. 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?arrayOptional. The available maintenance versions that an instance could update to.
connectMode?enumOptional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
customerManagedKey?stringOptional. The KMS key reference that the customer provides when trying to create the instance.
displayName?stringAn arbitrary and optional user-provided name for the instance.
labels?recordResource labels to represent user provided metadata
locationId?stringOptional. 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?objectOutput only. The time when the policy was created.
maintenanceSchedule?objectIf the scheduled maintenance can be rescheduled, default is true.
maintenanceVersion?stringOptional. The self service update maintenance version. The version is date based such as "20210712_00_00".
memorySizeGb?numberRequired. Redis memory size in GiB.
name?stringRequired. 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?objectOptional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.
readReplicasMode?enumOptional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
redisConfigs?recordOptional. 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?stringOptional. 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?numberOptional. 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?stringOptional. 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?stringOptional. 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?arrayOptional. reasons that causes instance in "SUSPENDED" state.
tags?recordOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tier?enumRequired. The service tier of the instance.
transitEncryptionMode?enumOptional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
instanceId?stringRequired. 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?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
exportexport
ArgumentTypeDescription
outputConfig?any
failoverfailover
ArgumentTypeDescription
dataProtectionMode?any
get_auth_stringget auth string
importimport
ArgumentTypeDescription
inputConfig?any
reschedule_maintenancereschedule maintenance
ArgumentTypeDescription
rescheduleType?any
scheduleTime?any
upgradeupgrade
ArgumentTypeDescription
redisVersion?any
clusters_tokenauthusers_authtokens.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 authTokens
ArgumentTypeDescription
identifierstringThe name of the authTokens
deleteDelete the authTokens
ArgumentTypeDescription
identifierstringThe name of the authTokens
syncSync authTokens state from GCP
aclpolicies.tsv2026.04.23.1

Global Arguments

ArgumentTypeDescription
name?stringIdentifier. Full resource path of the ACL policy.
rules?arrayRequired. 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?stringRequired. 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?stringOptional. Idempotent request UUID..
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a aclPolicies
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a aclPolicies
ArgumentTypeDescription
identifierstringThe name of the aclPolicies
updateUpdate aclPolicies attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the aclPolicies
ArgumentTypeDescription
identifierstringThe name of the aclPolicies
syncSync aclPolicies state from GCP
backupcollections_backups.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 backups
ArgumentTypeDescription
identifierstringThe name of the backups
deleteDelete the backups
ArgumentTypeDescription
identifierstringThe name of the backups
syncSync backups state from GCP
exportexport
ArgumentTypeDescription
gcsBucket?any