Aws/elasticache
@swamp/aws/elasticachev2026.06.03.1
01README
AWS ELASTICACHE infrastructure models
02Release Notes
- Updated: replication_group
03Models
cache_cluster.tsv2026.05.06.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| AutoMinorVersionUpgrade? | boolean | If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. |
| AZMode? | string | Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. |
| CacheNodeType | string | The compute and memory capacity of the nodes in the node group (shard). |
| CacheParameterGroupName? | string | The name of the parameter group to associate with this cluster. |
| CacheSecurityGroupNames? | array | A list of security group names to associate with this cluster. |
| CacheSubnetGroupName? | string | The name of the subnet group to be used for the cluster. |
| NotificationTopicArn? | string | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
| SnapshotArns? | array | A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. |
| NumCacheNodes | number | The number of cache nodes that the cache cluster should have. |
| SnapshotName? | string | The name of a Redis snapshot from which to restore data into the new node group (shard). |
| PreferredAvailabilityZones? | array | A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. |
| VpcSecurityGroupIds? | array | One or more VPC security groups associated with the cluster. |
| ClusterName? | string | A name for the cache cluster. |
| Engine | string | The name of the cache engine to be used for this cluster. |
| Tags? | array | A list of tags to be added to this resource. |
| EngineVersion? | string | The version number of the cache engine to be used for this cluster |
| PreferredMaintenanceWindow? | string | Specifies the weekly time range during which maintenance on the cluster is performed. |
| PreferredAvailabilityZone? | string | The EC2 Availability Zone in which the cluster is created. |
| SnapshotWindow? | string | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). |
| NetworkType? | string | The network type parameter for cachecluster. |
| IpDiscovery? | string | The Ip Discovery parameter for cachecluster. |
| SnapshotRetentionLimit? | number | The number of days for which ElastiCache retains automatic snapshots before deleting them. |
| LogDeliveryConfigurations? | array | Specifies the destination, format and type of the logs |
| TransitEncryptionEnabled? | boolean | A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created |
fn create()
Create a ElastiCache CacheCluster
fn get(identifier: string)
Get a ElastiCache CacheCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache CacheCluster |
fn update()
Update a ElastiCache CacheCluster
fn delete(identifier: string)
Delete a ElastiCache CacheCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache CacheCluster |
fn sync()
Sync ElastiCache CacheCluster state from AWS
global_replication_group.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| GlobalReplicationGroupIdSuffix? | string | The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix. |
| AutomaticFailoverEnabled? | boolean | AutomaticFailoverEnabled |
| CacheNodeType? | string | The cache node type of the Global Datastore |
| EngineVersion? | string | The engine version of the Global Datastore. |
| Engine? | string | The engine of the Global Datastore. |
| CacheParameterGroupName? | string | Cache parameter group name to use for the new engine version. This parameter cannot be modified independently. |
| GlobalNodeGroupCount? | number | Indicates the number of node groups in the Global Datastore. |
| GlobalReplicationGroupDescription? | string | The optional description of the Global Datastore |
| Members | array | The replication groups that comprise the Global Datastore. |
| RegionalConfigurations? | array | Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore |
fn create()
Create a ElastiCache GlobalReplicationGroup
fn get(identifier: string)
Get a ElastiCache GlobalReplicationGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache GlobalReplicationGroup |
fn update()
Update a ElastiCache GlobalReplicationGroup
fn delete(identifier: string)
Delete a ElastiCache GlobalReplicationGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache GlobalReplicationGroup |
fn sync()
Sync ElastiCache GlobalReplicationGroup state from AWS
parameter_group.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Description | string | The description for this cache parameter group. |
| Properties? | record | A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. |
| Tags? | array | Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. |
| CacheParameterGroupFamily | string | The name of the cache parameter group family that this cache parameter group is compatible with. |
fn create()
Create a ElastiCache ParameterGroup
fn get(identifier: string)
Get a ElastiCache ParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ParameterGroup |
fn update()
Update a ElastiCache ParameterGroup
fn delete(identifier: string)
Delete a ElastiCache ParameterGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ParameterGroup |
fn sync()
Sync ElastiCache ParameterGroup state from AWS
replication_group.tsv2026.06.03.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| ReplicationGroupId? | string | The replication group identifier. This parameter is stored as a lowercase string. |
| PreferredCacheClusterAZs? | array | A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. |
| CacheSecurityGroupNames? | array | A list of cache security group names to associate with this replication group. |
| NodeGroupConfiguration? | array | NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. |
| LogDeliveryConfigurations? | array | Specifies the destination, format and type of the logs. |
| SnapshotArns? | array | A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. |
| UserGroupIds? | array | The ID of user group to associate with the replication group. |
| NumNodeGroups? | number | An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. |
| NotificationTopicArn? | string | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. |
| SnapshotName? | string | The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created. |
| AutomaticFailoverEnabled? | boolean | Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. |
| ReplicasPerNodeGroup? | number | An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. **Note:** Using ReplicasPerNodeGroup with NodeGroupConfiguration results in resource replacement. For online scaling, use ReplicasPerNodeGroup alone. |
| ReplicationGroupDescription | string | A user-created description for the replication group. |
| MultiAZEnabled? | boolean | A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. |
| TransitEncryptionEnabled? | boolean | A flag that enables in-transit encryption when set to true. |
| Engine? | string | The name of the cache engine to be used for the clusters in this replication group. |
| Tags? | array | A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. |
| NumCacheClusters? | number | The number of clusters this replication group initially has.This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. |
| EngineVersion? | string | The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. |
| KmsKeyId? | string | The ID of the KMS key used to encrypt the disk on the cluster. |
| CacheSubnetGroupName? | string | The name of the cache subnet group to be used for the replication group. |
| CacheParameterGroupName? | string | The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. |
| PreferredMaintenanceWindow? | string | Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. |
| PrimaryClusterId? | string | The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. |
| AtRestEncryptionEnabled? | boolean | A flag that enables encryption at rest when set to true.AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. |
| AutoMinorVersionUpgrade? | boolean | This parameter is currently disabled. |
| SecurityGroupIds? | array | One or more Amazon VPC security groups associated with this replication group. |
| SnapshotWindow? | string | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). |
| CacheNodeType? | string | The compute and memory capacity of the nodes in the node group (shard). |
| SnapshotRetentionLimit? | number | The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. |
| SnapshottingClusterId? | string | The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups. |
| AuthToken? | string | Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information. |
| IpDiscovery? | string | The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system. |
| NetworkType? | string | Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system |
| GlobalReplicationGroupId? | string | The name of the Global datastore |
| DataTieringEnabled? | boolean | Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. |
| TransitEncryptionMode? | string | A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only. Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group. |
| ClusterMode? | string | Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode. |
| Durability? | enum | The durability setting for the replication group. Valid values: default, async, sync, disabled. Enabling durability on an existing non-durable cluster or disabling durability on an existing durable cluster is not currently supported and will result in an error; specify the desired durability at create time. The resolved state is returned in EffectiveDurability. |
fn create()
Create a ElastiCache ReplicationGroup
fn get(identifier: string)
Get a ElastiCache ReplicationGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ReplicationGroup |
fn update()
Update a ElastiCache ReplicationGroup
fn delete(identifier: string)
Delete a ElastiCache ReplicationGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ReplicationGroup |
fn sync()
Sync ElastiCache ReplicationGroup state from AWS
serverless_cache.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| ServerlessCacheName | string | The name of the Serverless Cache. This value must be unique. |
| Description? | string | The description of the Serverless Cache. |
| Engine | string | The engine name of the Serverless Cache. |
| MajorEngineVersion? | string | The major engine version of the Serverless Cache. |
| CacheUsageLimits? | object | The cached data capacity of the Serverless Cache. |
| KmsKeyId? | string | The ID of the KMS key used to encrypt the cluster. |
| SecurityGroupIds? | array | One or more Amazon VPC security groups associated with this Serverless Cache. |
| SnapshotArnsToRestore? | array | The ARN's of snapshot to restore Serverless Cache. |
| Tags? | array | An array of key-value pairs to apply to this Serverless Cache. |
| UserGroupId? | string | The ID of the user group. |
| SubnetIds? | array | The subnet id's of the Serverless Cache. |
| SnapshotRetentionLimit? | number | The snapshot retention limit of the Serverless Cache. |
| DailySnapshotTime? | string | The daily time range (in UTC) during which the service takes automatic snapshot of the Serverless Cache. |
| FinalSnapshotName? | string | The final snapshot name which is taken before Serverless Cache is deleted. |
fn create()
Create a ElastiCache ServerlessCache
fn get(identifier: string)
Get a ElastiCache ServerlessCache
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ServerlessCache |
fn update()
Update a ElastiCache ServerlessCache
fn delete(identifier: string)
Delete a ElastiCache ServerlessCache
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache ServerlessCache |
fn sync()
Sync ElastiCache ServerlessCache state from AWS
subnet_group.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| Description | string | The description for the cache subnet group. |
| SubnetIds | array | The EC2 subnet IDs for the cache subnet group. |
| CacheSubnetGroupName? | string | The name for the cache subnet group. This value is stored as a lowercase string. |
| Tags? | array |
fn create()
Create a ElastiCache SubnetGroup
fn get(identifier: string)
Get a ElastiCache SubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache SubnetGroup |
fn update()
Update a ElastiCache SubnetGroup
fn delete(identifier: string)
Delete a ElastiCache SubnetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache SubnetGroup |
fn sync()
Sync ElastiCache SubnetGroup state from AWS
user.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| UserId | string | The ID of the user. |
| UserName | string | The username of the user. |
| Engine | enum | The target cache engine for the user. |
| AccessString? | string | Access permissions string used for this user account. |
| NoPasswordRequired? | boolean | Indicates a password is not required for this user account. |
| Passwords? | array | Passwords used for this user account. You can create up to two passwords for each user. |
| AuthenticationMode? | object | Authentication Type |
| Tags? | array | An array of key-value pairs to apply to this user. |
fn create()
Create a ElastiCache User
fn get(identifier: string)
Get a ElastiCache User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache User |
fn update()
Update a ElastiCache User
fn delete(identifier: string)
Delete a ElastiCache User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache User |
fn sync()
Sync ElastiCache User state from AWS
user_group.tsv2026.04.23.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| UserGroupId | string | The ID of the user group. |
| Engine | enum | The target cache engine for the user group. |
| UserIds | array | List of users associated to this user group. |
| Tags? | array | An array of key-value pairs to apply to this user. |
fn create()
Create a ElastiCache UserGroup
fn get(identifier: string)
Get a ElastiCache UserGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache UserGroup |
fn update()
Update a ElastiCache UserGroup
fn delete(identifier: string)
Delete a ElastiCache UserGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ElastiCache UserGroup |
fn sync()
Sync ElastiCache UserGroup state from AWS
04Previous Versions
2026.05.20.1May 20, 2026
- Updated: replication_group
2026.05.14.1May 14, 2026
- Updated: replication_group
2026.05.06.1May 6, 2026
- Added: cache_cluster
2026.04.23.3Apr 23, 2026
2026.04.23.2Apr 23, 2026
- Updated: global_replication_group, parameter_group, replication_group, serverless_cache, subnet_group, user, user_group
2026.04.03.2Apr 3, 2026
- Updated: global_replication_group, parameter_group, replication_group, serverless_cache, subnet_group, user, user_group
2026.03.19.1Mar 19, 2026
- Updated: global_replication_group, parameter_group, replication_group, serverless_cache, subnet_group, user, user_group
2026.03.16.1Mar 16, 2026
- Updated: global_replication_group, parameter_group, replication_group, serverless_cache, subnet_group, user, user_group
2026.03.13.1Mar 13, 2026
- Added: replication_group
2026.03.10.5Mar 10, 2026
05Stats
B
85 / 100
Downloads
3
Archive size
1.9 MB
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 types1/1earned
- Dependencies pass trust audit0/2missing
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels