This table represents the ElastiCache resource from Amazon Web Services.

aws.elasticache

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
arncorestringThe ARN (Amazon Resource Name) of the cache cluster.
at_rest_encryption_enabledcoreboolA flag that enables encryption at-rest when set to <code>true</code>. You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the cluster is created. To enable at-rest encryption on a cluster you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create a cluster. <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Redis OSS version <code>3.2.6</code>, <code>4.x</code> or later. Default: <code>false</code>
auth_token_enabledcoreboolA flag that enables using an <code>AuthToken</code> (password) when issuing Valkey or Redis OSS commands. Default: <code>false</code>
auth_token_last_modified_datecoretimestampThe date the auth token was last modified
auto_minor_version_upgradecoreboolIf 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_timecoretimestampThe date and time when the cluster was created.
cache_cluster_idcorestringThe user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cache_cluster_statuscorestringThe current state of this cluster, one of the following values: <code>available</code>, <code>creating</code>, <code>deleted</code>, <code>deleting</code>, <code>incompatible-network</code>, <code>modifying</code>, <code>rebooting cluster nodes</code>, <code>restore-failed</code>, or <code>snapshotting</code>.
cache_node_typecorestringThe 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. <ul> <li> General purpose: <ul> <li> Current generation: <b>M7g node types</b>: <code>cache.m7g.large</code>, <code>cache.m7g.xlarge</code>, <code>cache.m7g.2xlarge</code>, <code>cache.m7g.4xlarge</code>, <code>cache.m7g.8xlarge</code>, <code>cache.m7g.12xlarge</code>, <code>cache.m7g.16xlarge</code> <note> For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a> </note> <b>M6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.m6g.large</code>, <code>cache.m6g.xlarge</code>, <code>cache.m6g.2xlarge</code>, <code>cache.m6g.4xlarge</code>, <code>cache.m6g.8xlarge</code>, <code>cache.m6g.12xlarge</code>, <code>cache.m6g.16xlarge</code> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> <b>T4g node types</b> (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): <code>cache.t4g.micro</code>, <code>cache.t4g.small</code>, <code>cache.t4g.medium</code> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </li> <li> Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) <b>T1 node types:</b> <code>cache.t1.micro</code> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </li> </ul> </li> <li> Compute optimized: <ul> <li> Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) <b>C1 node types:</b> <code>cache.c1.xlarge</code> </li> </ul> </li> <li> Memory optimized: <ul> <li> Current generation: <b>R7g node types</b>: <code>cache.r7g.large</code>, <code>cache.r7g.xlarge</code>, <code>cache.r7g.2xlarge</code>, <code>cache.r7g.4xlarge</code>, <code>cache.r7g.8xlarge</code>, <code>cache.r7g.12xlarge</code>, <code>cache.r7g.16xlarge</code> <note> For region availability, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion">Supported Node Types</a> </note> <b>R6g node types</b> (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): <code>cache.r6g.large</code>, <code>cache.r6g.xlarge</code>, <code>cache.r6g.2xlarge</code>, <code>cache.r6g.4xlarge</code>, <code>cache.r6g.8xlarge</code>, <code>cache.r6g.12xlarge</code>, <code>cache.r6g.16xlarge</code> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </li> <li> Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </li> </ul> </li> </ul> <b>Additional node type info</b> <ul> <li> All current generation instance types are created in Amazon VPC by default. </li> <li> Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. </li> <li> Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. </li> <li> The configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Valkey, or on Redis OSS version 2.8.22 and later. </li> </ul>
cache_nodescorejsonA list of cache nodes that are members of the cluster.
cache_parameter_groupcorejsonStatus of the cache parameter group.
cache_security_groupscorejsonA list of cache security group elements, composed of name and status sub-elements.
cache_subnet_group_namecorestringThe name of the cache subnet group associated with the cluster.
client_download_landing_pagecorestringThe URL of the web page where you can download the latest ElastiCache client library.
configuration_endpointcorejsonRepresents 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 <code>.cfg</code> in it. Example: <code>mem-3.9dvc4r<u>.cfg</u>.usw2.cache.amazonaws.com:11211</code>
enginecorestringThe name of the cache engine (<code>memcached</code> or <code>redis</code>) to be used for this cluster.
engine_versioncorestringThe version of the cache engine that is used in this cluster.
ip_discoverycorestringThe network type associated with the cluster, either <code>ipv4</code> | <code>ipv6</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href="http://aws.amazon.com/ec2/nitro/">Nitro system</a>.
log_delivery_configurationscorejsonReturns the destination, format and type of the logs.
network_typecorestringMust be either <code>ipv4</code> | <code>ipv6</code> | <code>dual_stack</code>. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the <a href="http://aws.amazon.com/ec2/nitro/">Nitro system</a>.
notification_configurationcorejsonDescribes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
num_cache_nodescoreint64The 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_valuescorejson
preferred_availability_zonecorestringThe 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_windowcorestringSpecifies 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 <code>ddd</code> are: <ul> <li> <code>sun</code> </li> <li> <code>mon</code> </li> <li> <code>tue</code> </li> <li> <code>wed</code> </li> <li> <code>thu</code> </li> <li> <code>fri</code> </li> <li> <code>sat</code> </li> </ul> Example: <code>sun:23:00-mon:01:30</code>
preferred_outpost_arncorestringThe outpost ARN in which the cache cluster is created.
replication_group_idcorestringThe 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_enabledcoreboolA boolean value indicating whether log delivery is enabled for the replication group.
security_groupscorejsonA list of VPC Security Groups associated with the cluster.
snapshot_retention_limitcoreint64The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set <code>SnapshotRetentionLimit</code> to 5, a snapshot that was taken today is retained for 5 days before being deleted. <important> If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. </important>
snapshot_windowcorestringThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: <code>05:00-09:00</code>
tagscorehstore
transit_encryption_enabledcoreboolA flag that enables in-transit encryption when set to <code>true</code>. <b>Required:</b> Only available when creating a replication group in an Amazon VPC using Redis OSS version <code>3.2.6</code>, <code>4.x</code> or later. Default: <code>false</code>
transit_encryption_modecorestringA setting that allows you to migrate your clients to use in-transit encryption, with no downtime.