cache_clusters

Creates, updates, deletes, gets or lists a cache_clusters resource.

Overview

Name	cache_clusters
Type	Resource
Id	aws.elasticache.cache_clusters

Fields

The following fields are returned by SELECT queries:

describe_cache_clusters

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) of the cache cluster.
at_rest_encryption_enabled	boolean	A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false
auth_token_enabled	boolean	A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands. Default: false
auth_token_last_modified_date	string	The date the auth token was last modified
auto_minor_version_upgrade	boolean	If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
cache_cluster_create_time	string	The date and time when the cluster was created.
cache_cluster_id	string	The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cache_cluster_status	string	The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
cache_node_type	string	The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
cache_nodes	string	A list of cache nodes that are members of the cluster.
cache_parameter_group	string	Status of the cache parameter group.
cache_security_groups	string	A list of cache security group elements, composed of name and status sub-elements.
cache_subnet_group_name	string	The name of the cache subnet group associated with the cluster.
client_download_landing_page	string	The URL of the web page where you can download the latest ElastiCache client library.
configuration_endpoint	string	Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
engine	string	The name of the cache engine (memcached or redis) to be used for this cluster.
engine_version	string	The version of the cache engine that is used in this cluster.
ip_discovery	string	The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
log_delivery_configurations	string	Returns the destination, format and type of the logs.
network_type	string	Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
notification_configuration	string	Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
num_cache_nodes	integer	The number of cache nodes in the cluster. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
pending_modified_values	string	A group of settings that are applied to the cluster in the future, or that are currently being applied.
preferred_availability_zone	string	The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
preferred_maintenance_window	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. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
preferred_outpost_arn	string	The outpost ARN in which the cache cluster is created.
replication_group_id	string	The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
replication_group_log_delivery_enabled	boolean	A boolean value indicating whether log delivery is enabled for the replication group.
security_groups	string	A list of VPC Security Groups associated with the cluster.
snapshot_retention_limit	integer	The number of days for which ElastiCache retains automatic cluster 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. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
snapshot_window	string	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00
transit_encryption_enabled	boolean	A flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false
transit_encryption_mode	string	A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cache_clusters	select	region	CacheClusterId, MaxRecords, Marker, ShowCacheNodeInfo, ShowCacheClustersNotInReplicationGroups	Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
create_cache_cluster	insert	CacheClusterId, region	ReplicationGroupId, AZMode, PreferredAvailabilityZone, PreferredAvailabilityZones, NumCacheNodes, CacheNodeType, Engine, EngineVersion, CacheParameterGroupName, CacheSubnetGroupName, CacheSecurityGroupNames, SecurityGroupIds, Tags, SnapshotArns, SnapshotName, PreferredMaintenanceWindow, Port, NotificationTopicArn, AutoMinorVersionUpgrade, SnapshotRetentionLimit, SnapshotWindow, AuthToken, OutpostMode, PreferredOutpostArn, PreferredOutpostArns, LogDeliveryConfigurations, TransitEncryptionEnabled, NetworkType, IpDiscovery	Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.
modify_cache_cluster	update	CacheClusterId, region	NumCacheNodes, CacheNodeIdsToRemove, AZMode, NewAvailabilityZones, CacheSecurityGroupNames, SecurityGroupIds, PreferredMaintenanceWindow, NotificationTopicArn, CacheParameterGroupName, NotificationTopicStatus, ApplyImmediately, Engine, EngineVersion, AutoMinorVersionUpgrade, SnapshotRetentionLimit, SnapshotWindow, CacheNodeType, AuthToken, AuthTokenUpdateStrategy, LogDeliveryConfigurations, IpDiscovery, ScaleConfig	Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
delete_cache_cluster	delete	CacheClusterId, region	FinalSnapshotIdentifier	Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation is not valid for: Valkey or Redis OSS (cluster mode enabled) clusters Valkey or Redis OSS (cluster mode disabled) clusters A cluster that is the last read replica of a replication group A cluster that is the primary node of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group A cluster that is not in the available state
reboot_cache_cluster	exec	CacheClusterId, CacheNodeIdsToReboot, region		Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters. If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CacheClusterId	string	The cluster identifier. This parameter is stored as a lowercase string.
CacheNodeIdsToReboot	array	A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
region	string	AWS region (default: us-east-1)
AZMode	string	Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az. This option is only supported for Memcached clusters. You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes are located in different Availability Zones.
ApplyImmediately	boolean	If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. However, a pending node-count increase on Memcached clusters cannot be superseded by a request to add fewer nodes. To change a pending node addition, first cancel it by setting NumCacheNodes equal to the current number of nodes in the cluster, then submit the new request. See the NumCacheNodes parameter for details on node scaling behavior. Valid values: true | false Default: false
AuthToken	string	Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints: Must be only printable ASCII characters Must be at least 16 characters and no more than 128 characters in length Cannot contain any of the following characters: '/', '"', or '@', '%' For more information, see AUTH password at AUTH.
AuthTokenUpdateStrategy	string	Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: ROTATE - default, if no update strategy is provided SET - allowed only after ROTATE DELETE - allowed only when transitioning to RBAC For more information, see Authenticating Users with AUTH
AutoMinorVersionUpgrade	boolean	If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
CacheClusterId	string	The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
CacheNodeIdsToRemove	array	A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
CacheNodeType	string	A valid cache node type that you want to scale this cluster up to.
CacheParameterGroupName	string	The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
CacheSecurityGroupNames	array	A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
CacheSubnetGroupName	string	The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
Engine	string	The engine type used by the cache cluster. The options are valkey, memcached or redis.
EngineVersion	string	The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
FinalSnapshotIdentifier	string	The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
IpDiscovery	string	The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
LogDeliveryConfigurations	array	Specifies the destination, format and type of the logs.
Marker	string	An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20; maximum 100.
NetworkType	string	Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
NewAvailabilityZones	array	This option is only supported on Memcached clusters. The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Impact of new add/remove requests upon pending requests Scenario-1 Pending Action: Delete New Request: Delete Result: The new delete, pending or immediate, replaces the pending delete. Scenario-2 Pending Action: Delete New Request: Create Result: The new create, pending or immediate, replaces the pending delete. Scenario-3 Pending Action: Create New Request: Delete Result: The new delete, pending or immediate, replaces the pending create. Scenario-4 Pending Action: Create New Request: Create Result: The new create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
NotificationTopicArn	string	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
NotificationTopicStatus	string	The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive
NumCacheNodes	integer	The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40. Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
OutpostMode	string	Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
Port	integer	The port number on which each of the cache nodes accepts connections.
PreferredAvailabilityZone	string	The EC2 Availability Zone in which the cluster is created. All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone.
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. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones.
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. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
PreferredOutpostArn	string	The outpost ARN in which the cache cluster is created.
PreferredOutpostArns	array	The outpost ARNs in which the cache cluster is created.
ReplicationGroupId	string	The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis.
ScaleConfig	object	Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.
SecurityGroupIds	array	Specifies the VPC Security Groups associated with the cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
ShowCacheClustersNotInReplicationGroups	boolean	An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.
ShowCacheNodeInfo	boolean	An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
SnapshotArns	array	A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
SnapshotName	string	The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis.
SnapshotRetentionLimit	integer	The number of days for which ElastiCache retains automatic cluster 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. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow	string	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Tags	array	A list of tags to be added to this resource.
TransitEncryptionEnabled	boolean	A flag that enables in-transit encryption when set to true.

SELECT examples

describe_cache_clusters

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

SELECT
arn,
at_rest_encryption_enabled,
auth_token_enabled,
auth_token_last_modified_date,
auto_minor_version_upgrade,
cache_cluster_create_time,
cache_cluster_id,
cache_cluster_status,
cache_node_type,
cache_nodes,
cache_parameter_group,
cache_security_groups,
cache_subnet_group_name,
client_download_landing_page,
configuration_endpoint,
engine,
engine_version,
ip_discovery,
log_delivery_configurations,
network_type,
notification_configuration,
num_cache_nodes,
pending_modified_values,
preferred_availability_zone,
preferred_maintenance_window,
preferred_outpost_arn,
replication_group_id,
replication_group_log_delivery_enabled,
security_groups,
snapshot_retention_limit,
snapshot_window,
transit_encryption_enabled,
transit_encryption_mode
FROM aws.elasticache.cache_clusters
WHERE region = '{{ region }}' -- required
AND CacheClusterId = '{{ CacheClusterId }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND ShowCacheNodeInfo = '{{ ShowCacheNodeInfo }}'
AND ShowCacheClustersNotInReplicationGroups = '{{ ShowCacheClustersNotInReplicationGroups }}'
;

INSERT examples

create_cache_cluster

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

INSERT INTO aws.elasticache.cache_clusters (
CacheClusterId,
region,
ReplicationGroupId,
AZMode,
PreferredAvailabilityZone,
PreferredAvailabilityZones,
NumCacheNodes,
CacheNodeType,
Engine,
EngineVersion,
CacheParameterGroupName,
CacheSubnetGroupName,
CacheSecurityGroupNames,
SecurityGroupIds,
Tags,
SnapshotArns,
SnapshotName,
PreferredMaintenanceWindow,
Port,
NotificationTopicArn,
AutoMinorVersionUpgrade,
SnapshotRetentionLimit,
SnapshotWindow,
AuthToken,
OutpostMode,
PreferredOutpostArn,
PreferredOutpostArns,
LogDeliveryConfigurations,
TransitEncryptionEnabled,
NetworkType,
IpDiscovery
)
SELECT 
'{{ CacheClusterId }}',
'{{ region }}',
'{{ ReplicationGroupId }}',
'{{ AZMode }}',
'{{ PreferredAvailabilityZone }}',
'{{ PreferredAvailabilityZones }}',
'{{ NumCacheNodes }}',
'{{ CacheNodeType }}',
'{{ Engine }}',
'{{ EngineVersion }}',
'{{ CacheParameterGroupName }}',
'{{ CacheSubnetGroupName }}',
'{{ CacheSecurityGroupNames }}',
'{{ SecurityGroupIds }}',
'{{ Tags }}',
'{{ SnapshotArns }}',
'{{ SnapshotName }}',
'{{ PreferredMaintenanceWindow }}',
'{{ Port }}',
'{{ NotificationTopicArn }}',
'{{ AutoMinorVersionUpgrade }}',
'{{ SnapshotRetentionLimit }}',
'{{ SnapshotWindow }}',
'{{ AuthToken }}',
'{{ OutpostMode }}',
'{{ PreferredOutpostArn }}',
'{{ PreferredOutpostArns }}',
'{{ LogDeliveryConfigurations }}',
'{{ TransitEncryptionEnabled }}',
'{{ NetworkType }}',
'{{ IpDiscovery }}'
RETURNING
arn,
at_rest_encryption_enabled,
auth_token_enabled,
auth_token_last_modified_date,
auto_minor_version_upgrade,
cache_cluster_create_time,
cache_cluster_id,
cache_cluster_status,
cache_node_type,
cache_nodes,
cache_parameter_group,
cache_security_groups,
cache_subnet_group_name,
client_download_landing_page,
configuration_endpoint,
engine,
engine_version,
ip_discovery,
log_delivery_configurations,
network_type,
notification_configuration,
num_cache_nodes,
pending_modified_values,
preferred_availability_zone,
preferred_maintenance_window,
preferred_outpost_arn,
replication_group_id,
replication_group_log_delivery_enabled,
security_groups,
snapshot_retention_limit,
snapshot_window,
transit_encryption_enabled,
transit_encryption_mode
;

Manifest

# Description fields are for documentation purposes
- name: cache_clusters
props:
  - name: CacheClusterId
    value: "{{ CacheClusterId }}"
    description: Required parameter for the cache_clusters resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cache_clusters resource.
  - name: ReplicationGroupId
    value: "{{ ReplicationGroupId }}"
    description: The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis.
    description: The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis.
  - name: AZMode
    value: "{{ AZMode }}"
    description: 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. This parameter is only supported for Memcached clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
    description: 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. This parameter is only supported for Memcached clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
  - name: PreferredAvailabilityZone
    value: "{{ PreferredAvailabilityZone }}"
    description: The EC2 Availability Zone in which the cluster is created. All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone.
    description: The EC2 Availability Zone in which the cluster is created. All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone.
  - name: PreferredAvailabilityZones
    value: "{{ PreferredAvailabilityZones }}"
    description: A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones.
    description: A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones.
  - name: NumCacheNodes
    value: {{ NumCacheNodes }}
    description: The initial number of cache nodes that the cluster has. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40. If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
    description: The initial number of cache nodes that the cluster has. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40. If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
  - name: CacheNodeType
    value: "{{ CacheNodeType }}"
    description: The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
    description: The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
  - name: Engine
    value: "{{ Engine }}"
    description: The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis
    description: The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis
  - name: EngineVersion
    value: "{{ EngineVersion }}"
    description: The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
    description: The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
  - name: CacheParameterGroupName
    value: "{{ CacheParameterGroupName }}"
    description: The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
    description: The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
  - name: CacheSubnetGroupName
    value: "{{ CacheSubnetGroupName }}"
    description: The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
    description: The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
  - name: CacheSecurityGroupNames
    value: "{{ CacheSecurityGroupNames }}"
    description: A list of security group names to associate with this cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
    description: A list of security group names to associate with this cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
  - name: SecurityGroupIds
    value: "{{ SecurityGroupIds }}"
    description: One or more VPC security groups associated with the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
    description: One or more VPC security groups associated with the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
  - name: Tags
    value: "{{ Tags }}"
    description: A list of tags to be added to this resource.
    description: A list of tags to be added to this resource.
  - name: SnapshotArns
    value: "{{ SnapshotArns }}"
    description: A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
    description: A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
  - name: SnapshotName
    value: "{{ SnapshotName }}"
    description: The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis.
    description: The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis.
  - name: PreferredMaintenanceWindow
    value: "{{ PreferredMaintenanceWindow }}"
    description: 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.
    description: 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.
  - name: Port
    value: {{ Port }}
    description: The port number on which each of the cache nodes accepts connections.
    description: The port number on which each of the cache nodes accepts connections.
  - name: NotificationTopicArn
    value: "{{ NotificationTopicArn }}"
    description: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
    description: The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
  - name: AutoMinorVersionUpgrade
    value: {{ AutoMinorVersionUpgrade }}
    description: If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
    description: If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
  - name: SnapshotRetentionLimit
    value: {{ SnapshotRetentionLimit }}
    description: The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. This parameter is only valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled for this cache cluster).
    description: The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. This parameter is only valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled for this cache cluster).
  - name: SnapshotWindow
    value: "{{ SnapshotWindow }}"
    description: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
    description: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
  - name: AuthToken
    value: "{{ AuthToken }}"
    description: Reserved parameter. The password used to access a password protected server. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
    description: Reserved parameter. The password used to access a password protected server. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
  - name: OutpostMode
    value: "{{ OutpostMode }}"
    description: Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
    description: Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
  - name: PreferredOutpostArn
    value: "{{ PreferredOutpostArn }}"
    description: The outpost ARN in which the cache cluster is created.
    description: The outpost ARN in which the cache cluster is created.
  - name: PreferredOutpostArns
    value: "{{ PreferredOutpostArns }}"
    description: The outpost ARNs in which the cache cluster is created.
    description: The outpost ARNs in which the cache cluster is created.
  - name: LogDeliveryConfigurations
    value: "{{ LogDeliveryConfigurations }}"
    description: Specifies the destination, format and type of the logs.
    description: Specifies the destination, format and type of the logs.
  - name: TransitEncryptionEnabled
    value: {{ TransitEncryptionEnabled }}
    description: A flag that enables in-transit encryption when set to true.
    description: A flag that enables in-transit encryption when set to true.
  - name: NetworkType
    value: "{{ NetworkType }}"
    description: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
    description: Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
  - name: IpDiscovery
    value: "{{ IpDiscovery }}"
    description: The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
    description: The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

UPDATE examples

modify_cache_cluster

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

UPDATE aws.elasticache.cache_clusters
SET 
-- No updatable properties
WHERE 
CacheClusterId = '{{ CacheClusterId }}' --required
AND region = '{{ region }}' --required
AND NumCacheNodes = '{{ NumCacheNodes}}'
AND CacheNodeIdsToRemove = '{{ CacheNodeIdsToRemove}}'
AND AZMode = '{{ AZMode}}'
AND NewAvailabilityZones = '{{ NewAvailabilityZones}}'
AND CacheSecurityGroupNames = '{{ CacheSecurityGroupNames}}'
AND SecurityGroupIds = '{{ SecurityGroupIds}}'
AND PreferredMaintenanceWindow = '{{ PreferredMaintenanceWindow}}'
AND NotificationTopicArn = '{{ NotificationTopicArn}}'
AND CacheParameterGroupName = '{{ CacheParameterGroupName}}'
AND NotificationTopicStatus = '{{ NotificationTopicStatus}}'
AND ApplyImmediately = {{ ApplyImmediately}}
AND Engine = '{{ Engine}}'
AND EngineVersion = '{{ EngineVersion}}'
AND AutoMinorVersionUpgrade = {{ AutoMinorVersionUpgrade}}
AND SnapshotRetentionLimit = '{{ SnapshotRetentionLimit}}'
AND SnapshotWindow = '{{ SnapshotWindow}}'
AND CacheNodeType = '{{ CacheNodeType}}'
AND AuthToken = '{{ AuthToken}}'
AND AuthTokenUpdateStrategy = '{{ AuthTokenUpdateStrategy}}'
AND LogDeliveryConfigurations = '{{ LogDeliveryConfigurations}}'
AND IpDiscovery = '{{ IpDiscovery}}'
AND ScaleConfig = '{{ ScaleConfig}}'
RETURNING
arn,
at_rest_encryption_enabled,
auth_token_enabled,
auth_token_last_modified_date,
auto_minor_version_upgrade,
cache_cluster_create_time,
cache_cluster_id,
cache_cluster_status,
cache_node_type,
cache_nodes,
cache_parameter_group,
cache_security_groups,
cache_subnet_group_name,
client_download_landing_page,
configuration_endpoint,
engine,
engine_version,
ip_discovery,
log_delivery_configurations,
network_type,
notification_configuration,
num_cache_nodes,
pending_modified_values,
preferred_availability_zone,
preferred_maintenance_window,
preferred_outpost_arn,
replication_group_id,
replication_group_log_delivery_enabled,
security_groups,
snapshot_retention_limit,
snapshot_window,
transit_encryption_enabled,
transit_encryption_mode;

DELETE examples

delete_cache_cluster

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation is not valid for: Valkey or Redis OSS (cluster mode enabled) clusters Valkey or Redis OSS (cluster mode disabled) clusters A cluster that is the last read replica of a replication group A cluster that is the primary node of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group A cluster that is not in the available state

DELETE FROM aws.elasticache.cache_clusters
WHERE CacheClusterId = '{{ CacheClusterId }}' --required
AND region = '{{ region }}' --required
AND FinalSnapshotIdentifier = '{{ FinalSnapshotIdentifier }}'
;

Lifecycle Methods

reboot_cache_cluster

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters. If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

EXEC aws.elasticache.cache_clusters.reboot_cache_cluster 
@CacheClusterId='{{ CacheClusterId }}' --required, 
@CacheNodeIdsToReboot='{{ CacheNodeIdsToReboot }}' --required, 
@region='{{ region }}' --required
;