String resourceName
The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are
cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
SdkInternalList<T> tagList
A list of tags as key-value pairs.
String cacheSecurityGroupName
The cache security group that allows network ingress.
String eC2SecurityGroupName
The Amazon EC2 security group to be authorized for ingress to the cache security group.
String eC2SecurityGroupOwnerId
The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
String name
The name of the Availability Zone.
SdkInternalList<T> replicationGroupIds
The replication group IDs
SdkInternalList<T> cacheClusterIds
The cache cluster IDs
String serviceUpdateName
The unique ID of the service update
SdkInternalList<T> processedUpdateActions
Update actions that have been processed successfully
SdkInternalList<T> unprocessedUpdateActions
Update actions that haven't been processed successfully
SdkInternalList<T> replicationGroupIds
The replication group IDs
SdkInternalList<T> cacheClusterIds
The cache cluster IDs
String serviceUpdateName
The unique ID of the service update
SdkInternalList<T> processedUpdateActions
Update actions that have been processed successfully
SdkInternalList<T> unprocessedUpdateActions
Update actions that haven't been processed successfully
String cacheClusterId
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
Endpoint configurationEndpoint
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
String clientDownloadLandingPage
The URL of the web page where you can download the latest ElastiCache client library.
String cacheNodeType
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String engine
The name of the cache engine (memcached or redis) to be used for this cluster.
String engineVersion
The version of the cache engine that is used in this cluster.
String cacheClusterStatus
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.
Integer numCacheNodes
The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
String preferredAvailabilityZone
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
String preferredOutpostArn
The outpost ARN in which the cache cluster is created.
Date cacheClusterCreateTime
The date and time when the cluster was created.
String preferredMaintenanceWindow
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
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
SdkInternalList<T> cacheSecurityGroups
A list of cache security group elements, composed of name and status sub-elements.
CacheParameterGroupStatus cacheParameterGroup
Status of the cache parameter group.
String cacheSubnetGroupName
The name of the cache subnet group associated with the cluster.
SdkInternalList<T> cacheNodes
A list of cache nodes that are members of the cluster.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
SdkInternalList<T> securityGroups
A list of VPC Security Groups associated with the cluster.
String replicationGroupId
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
Integer snapshotRetentionLimit
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.
String snapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
Boolean authTokenEnabled
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
Date authTokenLastModifiedDate
The date the auth token was last modified
Boolean transitEncryptionEnabled
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Default: false
Boolean atRestEncryptionEnabled
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 version
3.2.6, 4.x or later.
Default: false
String aRN
The ARN (Amazon Resource Name) of the cache cluster.
Boolean replicationGroupLogDeliveryEnabled
A boolean value indicating whether log delivery is enabled for the replication group.
SdkInternalList<T> logDeliveryConfigurations
Returns the destination, format and type of the logs.
String engine
The name of the cache engine.
String engineVersion
The version number of the cache engine.
String cacheParameterGroupFamily
The name of the cache parameter group family associated with this cache engine.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
String cacheEngineDescription
The description of the cache engine.
String cacheEngineVersionDescription
The description of the cache engine version.
String cacheNodeId
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
String cacheNodeStatus
The current state of this cache node, one of the following values: available, creating,
rebooting, or deleting.
Date cacheNodeCreateTime
The date and time when the cache node was created.
Endpoint endpoint
The hostname for connecting to this cache node.
String parameterGroupStatus
The status of the parameter group applied to this cache node.
String sourceCacheNodeId
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
String customerAvailabilityZone
The Availability Zone where this node was created and now resides.
String customerOutpostArn
The customer outpost ARN of the cache node.
String parameterName
The name of the parameter.
String description
A description of the parameter.
String source
The source of the parameter value.
String dataType
The valid data type for the parameter.
String allowedValues
The valid range of values for the parameter.
Boolean isModifiable
Indicates whether (true) or not (false) the parameter can be modified. Some parameters
have security or operational implications that prevent them from being changed.
String minimumEngineVersion
The earliest cache engine version to which the parameter can apply.
SdkInternalList<T> cacheNodeTypeSpecificValues
A list of cache node types and their corresponding values for this parameter.
String changeType
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
String cacheNodeId
The node ID of the cache cluster
String nodeUpdateStatus
The update status of the node
Date nodeDeletionDate
The deletion date of the node
Date nodeUpdateStartDate
The start date of the update for a node
Date nodeUpdateEndDate
The end date of the update for a node
String nodeUpdateInitiatedBy
Reflects whether the update was initiated by the customer or automatically applied
Date nodeUpdateInitiatedDate
The date when the update is triggered
Date nodeUpdateStatusModifiedDate
The date when the NodeUpdateStatus was last modified>
String cacheParameterGroupName
The name of the cache parameter group.
String cacheParameterGroupFamily
The name of the cache parameter group family that this cache parameter group is compatible with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
String description
The description for this cache parameter group.
Boolean isGlobal
Indicates whether the parameter group is associated with a Global datastore
String aRN
The ARN (Amazon Resource Name) of the cache parameter group.
String cacheParameterGroupName
The name of the cache parameter group.
String parameterApplyStatus
The status of parameter updates.
SdkInternalList<T> cacheNodeIdsToReboot
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
String ownerId
The AWS account ID of the cache security group owner.
String cacheSecurityGroupName
The name of the cache security group.
String description
The description of the cache security group.
SdkInternalList<T> eC2SecurityGroups
A list of Amazon EC2 security groups that are associated with this cache security group.
String aRN
The ARN of the cache security group,
String cacheSubnetGroupName
The name of the cache subnet group.
String cacheSubnetGroupDescription
The description of the cache subnet group.
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
SdkInternalList<T> subnets
A list of subnets associated with the cache subnet group.
String aRN
The ARN (Amazon Resource Name) of the cache subnet group.
String logGroup
The name of the CloudWatch Logs log group.
String replicationGroupId
The ID of the replication group to which data is being migrated.
Boolean force
Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
String nodeGroupId
The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
Integer newReplicaCount
The number of replicas you want in this node group at the end of this operation. The maximum value for
NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are
working with.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ: 1
If Multi-AZ: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
SdkInternalList<T> preferredAvailabilityZones
A list of PreferredAvailabilityZone strings that specify which availability zones the replication
group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of
NewReplicaCount plus 1 to account for the primary node. If this member of
ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the
replicas.
SdkInternalList<T> preferredOutpostArns
The outpost ARNs in which the cache cluster is created.
String sourceSnapshotName
The name of an existing snapshot from which to make a copy.
String targetSnapshotName
A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
String targetBucket
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
String kmsKeyId
The ID of the KMS key used to encrypt the target snapshot.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String cacheClusterId
The node group (shard) identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
String replicationGroupId
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.
String aZMode
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.
String preferredAvailabilityZone
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.
SdkInternalList<T> preferredAvailabilityZones
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.
Integer numCacheNodes
The initial number of cache nodes that the cluster has.
For clusters running Redis, 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/.
String cacheNodeType
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String engine
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
String engineVersion
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.
String cacheParameterGroupName
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.
String cacheSubnetGroupName
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.
SdkInternalList<T> cacheSecurityGroupNames
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).
SdkInternalList<T> securityGroupIds
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).
SdkInternalList<T> tags
A list of tags to be added to this resource.
SdkInternalList<T> snapshotArns
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis 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
String snapshotName
The name of a Redis 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.
String preferredMaintenanceWindow
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:
Integer port
The port number on which each of the cache nodes accepts connections.
String notificationTopicArn
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.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
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).
String snapshotWindow
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.
String authToken
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.
String outpostMode
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
String preferredOutpostArn
The outpost ARN in which the cache cluster is created.
SdkInternalList<T> preferredOutpostArns
The outpost ARNs in which the cache cluster is created.
SdkInternalList<T> logDeliveryConfigurations
Specifies the destination, format and type of the logs.
String cacheParameterGroupName
A user-specified name for the cache parameter group.
String cacheParameterGroupFamily
The name of the cache parameter group family that the cache parameter group can be used with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
String description
A user-specified description for the cache parameter group.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String cacheSecurityGroupName
A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example: mysecuritygroup
String description
A description for the cache security group.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String cacheSubnetGroupName
A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
A description for the cache subnet group.
SdkInternalList<T> subnetIds
A list of VPC subnet IDs for the cache subnet group.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String globalReplicationGroupIdSuffix
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. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
For a full list of AWS Regions and their respective Global datastore iD prefixes, see Using the AWS CLI with Global datastores .
String globalReplicationGroupDescription
Provides details of the Global datastore
String primaryReplicationGroupId
The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
String replicationGroupId
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
String replicationGroupDescription
A user-created description for the replication group.
String globalReplicationGroupId
The name of the Global datastore
String primaryClusterId
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.
This parameter is not required if NumCacheClusters, NumNodeGroups, or
ReplicasPerNodeGroup is specified.
Boolean automaticFailoverEnabled
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.
Default: false
Boolean multiAZEnabled
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
Integer numCacheClusters
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.
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If
AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1),
or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
SdkInternalList<T> preferredCacheClusterAZs
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.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
Integer numNodeGroups
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.
Default: 1
Integer replicasPerNodeGroup
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
SdkInternalList<T> nodeGroupConfiguration
A list of node group (shard) configuration options. Each node group (shard) configuration has the following
members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount,
and Slots.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
String cacheNodeType
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String engine
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
String engineVersion
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.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, 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.
String cacheParameterGroupName
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.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis (cluster mode disabled) replication group, use
CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use
CacheParameterGroupName=default.redis3.2.cluster.on.
String cacheSubnetGroupName
The name of the cache subnet group to be used for the replication group.
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.
SdkInternalList<T> cacheSecurityGroupNames
A list of cache security group names to associate with this replication group.
SdkInternalList<T> securityGroupIds
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
SdkInternalList<T> tags
A list of 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. Tags on replication groups will be replicated to all nodes.
SdkInternalList<T> snapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
String snapshotName
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.
String preferredMaintenanceWindow
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:
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
Integer port
The port number on which each member of the replication group accepts connections.
String notificationTopicArn
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.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
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.
Default: 0 (i.e., automatic backups are disabled for this cluster).
String snapshotWindow
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.
String authToken
Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is
true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an
AuthToken, and a CacheSubnetGroup.
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.
Boolean transitEncryptionEnabled
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
you create a cluster.
This parameter is valid only if the Engine parameter is redis, the
EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being
created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an
AuthToken, and a CacheSubnetGroup.
Boolean atRestEncryptionEnabled
A flag that enables encryption at rest when set to true.
You cannot modify the value of 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.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Default: false
String kmsKeyId
The ID of the KMS key used to encrypt the disk in the cluster.
SdkInternalList<T> userGroupIds
The user group to associate with the replication group.
SdkInternalList<T> logDeliveryConfigurations
Specifies the destination, format and type of the logs.
String replicationGroupId
The identifier of an existing replication group. The snapshot is created from this replication group.
String cacheClusterId
The identifier of an existing cluster. The snapshot is created from this cluster.
String snapshotName
A name for the snapshot being created.
String kmsKeyId
The ID of the KMS key used to encrypt the snapshot.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String userGroupId
The ID of the user group.
String engine
The current supported value is Redis.
SdkInternalList<T> userIds
The list of user IDs that belong to the user group.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String userGroupId
The ID of the user group.
String status
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
String engine
The current supported value is Redis.
SdkInternalList<T> userIds
The list of user IDs that belong to the user group.
UserGroupPendingChanges pendingChanges
A list of updates being applied to the user groups.
SdkInternalList<T> replicationGroups
A list of replication groups that the user group can access.
String aRN
The Amazon Resource Name (ARN) of the user group.
String userId
The ID of the user.
String userName
The username of the user.
String engine
The current supported value is Redis.
SdkInternalList<T> passwords
Passwords used for this user. You can create up to two passwords for each user.
String accessString
Access permissions string used for this user.
Boolean noPasswordRequired
Indicates a password is not required for this user.
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String userId
The ID of the user.
String userName
The username of the user.
String status
Indicates the user status. Can be "active", "modifying" or "deleting".
String engine
The current supported value is Redis.
String accessString
Access permissions string used for this user.
SdkInternalList<T> userGroupIds
Returns a list of the user group IDs the user belongs to.
Authentication authentication
Denotes whether the user requires a password to authenticate.
String aRN
The Amazon Resource Name (ARN) of the user.
String globalReplicationGroupId
The name of the Global datastore
Integer nodeGroupCount
The number of node groups (shards) that results from the modification of the shard configuration
SdkInternalList<T> globalNodeGroupsToRemove
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
SdkInternalList<T> globalNodeGroupsToRetain
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
Boolean applyImmediately
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
String replicationGroupId
The id of the replication group from which you want to remove replica nodes.
Integer newReplicaCount
The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
SdkInternalList<T> replicaConfiguration
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode
enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
NodeGroupId, and PreferredAvailabilityZones.
SdkInternalList<T> replicasToRemove
A list of the node ids to remove from the replication group or node group (shard).
Boolean applyImmediately
If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
is not currently supported.
String cacheClusterId
The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
String finalSnapshotIdentifier
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.
String cacheParameterGroupName
The name of the cache parameter group to delete.
The specified cache security group must not be associated with any clusters.
String cacheSecurityGroupName
The name of the cache security group to delete.
You cannot delete the default security group.
String cacheSubnetGroupName
The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
String replicationGroupId
The identifier for the cluster to be deleted. This parameter is not case sensitive.
Boolean retainPrimaryCluster
If set to true, all of the read replicas are deleted, but the primary node is retained.
String finalSnapshotIdentifier
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
String snapshotName
The name of the snapshot to be deleted.
String userGroupId
The ID of the user group.
String userGroupId
The ID of the user group.
String status
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
String engine
The current supported value is Redis.
SdkInternalList<T> userIds
The list of user IDs that belong to the user group.
UserGroupPendingChanges pendingChanges
A list of updates being applied to the user groups.
SdkInternalList<T> replicationGroups
A list of replication groups that the user group can access.
String aRN
The Amazon Resource Name (ARN) of the user group.
String userId
The ID of the user.
String userId
The ID of the user.
String userName
The username of the user.
String status
Indicates the user status. Can be "active", "modifying" or "deleting".
String engine
The current supported value is Redis.
String accessString
Access permissions string used for this user.
SdkInternalList<T> userGroupIds
Returns a list of the user group IDs the user belongs to.
Authentication authentication
Denotes whether the user requires a password to authenticate.
String aRN
The Amazon Resource Name (ARN) of the user.
String cacheClusterId
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
Integer maxRecords
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.
String marker
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.
Boolean showCacheNodeInfo
An optional flag that can be included in the DescribeCacheCluster request to retrieve information
about the individual cache nodes.
Boolean showCacheClustersNotInReplicationGroups
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 mean Memcached and single node
Redis clusters.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> cacheClusters
A list of clusters. Each item in the list contains detailed information about one cluster.
String engine
The cache engine to return. Valid values: memcached | redis
String engineVersion
The cache engine version to return.
Example: 1.4.14
String cacheParameterGroupFamily
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Integer maxRecords
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.
String marker
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.
Boolean defaultOnly
If true, specifies that only the default version of the specified engine or engine and major version
combination is to be returned.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> cacheEngineVersions
A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
String cacheParameterGroupName
The name of a specific cache parameter group to return details for.
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> cacheParameterGroups
A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
String cacheParameterGroupName
The name of a specific cache parameter group to return details for.
String source
The parameter types to return.
Valid values: user | system | engine-default
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> parameters
A list of Parameter instances.
SdkInternalList<T> cacheNodeTypeSpecificParameters
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
String cacheSecurityGroupName
The name of the cache security group to return details for.
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> cacheSecurityGroups
A list of cache security groups. Each element in the list contains detailed information about one group.
String cacheSubnetGroupName
The name of the cache subnet group to return details for.
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> cacheSubnetGroups
A list of cache subnet groups. Each element in the list contains detailed information about one group.
String cacheParameterGroupFamily
The name of the cache parameter group family.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
Integer maxRecords
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.
String marker
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.
String sourceIdentifier
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
Integer duration
The number of minutes worth of events to retrieve.
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> events
A list of events. Each element in the list contains detailed information about one event.
String globalReplicationGroupId
The name of the Global datastore
Integer maxRecords
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.
String marker
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.
Boolean showMemberInfo
Returns the list of members that comprise the Global datastore.
String marker
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. >
SdkInternalList<T> globalReplicationGroups
Indicates the slot configuration and global identifier for each slice group.
String replicationGroupId
The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> replicationGroups
A list of replication groups. Each item in the list contains detailed information about one replication group.
String reservedCacheNodesOfferingId
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String cacheNodeType
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String duration
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
String productDescription
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
String offeringType
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values:
"Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> reservedCacheNodesOfferings
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
String reservedCacheNodeId
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
String reservedCacheNodesOfferingId
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
String cacheNodeType
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String duration
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
String productDescription
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
String offeringType
The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values:
"Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
Integer maxRecords
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.
String marker
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.
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> reservedCacheNodes
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
String serviceUpdateName
The unique ID of the service update
SdkInternalList<T> serviceUpdateStatus
The status of the service update
Integer maxRecords
The maximum number of records to include in the response
String marker
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.
String marker
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.
SdkInternalList<T> serviceUpdates
A list of service updates
String replicationGroupId
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
String cacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
String snapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
String snapshotSource
If set to system, the output shows snapshots that were automatically created by ElastiCache. If set
to user the output shows snapshots that were manually created. If omitted, the output shows both
automatically and manually created snapshots.
String marker
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.
Integer maxRecords
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: 50
Constraints: minimum 20; maximum 50.
Boolean showNodeGroupConfig
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
String marker
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.
SdkInternalList<T> snapshots
A list of snapshots. Each item in the list contains detailed information about one snapshot.
String serviceUpdateName
The unique ID of the service update
SdkInternalList<T> replicationGroupIds
The replication group IDs
SdkInternalList<T> cacheClusterIds
The cache cluster IDs
String engine
The Elasticache engine to which the update applies. Either Redis or Memcached
SdkInternalList<T> serviceUpdateStatus
The status of the service update
TimeRangeFilter serviceUpdateTimeRange
The range of time specified to search for service updates that are in available status
SdkInternalList<T> updateActionStatus
The status of the update action.
Boolean showNodeLevelUpdateStatus
Dictates whether to include node level update status in the response
Integer maxRecords
The maximum number of records to include in the response
String marker
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.
String marker
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.
SdkInternalList<T> updateActions
Returns a list of update actions
String userGroupId
The ID of the user group.
Integer maxRecords
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.
String marker
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. >
SdkInternalList<T> userGroups
Returns a list of user groups.
String marker
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. >
String engine
The Redis engine.
String userId
The ID of the user.
SdkInternalList<T> filters
Filter to determine the list of User IDs to return.
Integer maxRecords
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.
String marker
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. >
SdkInternalList<T> users
A list of users.
String marker
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. >
CloudWatchLogsDestinationDetails cloudWatchLogsDetails
The configuration details of the CloudWatch Logs destination.
KinesisFirehoseDestinationDetails kinesisFirehoseDetails
The configuration details of the Kinesis Data Firehose destination.
String globalReplicationGroupId
The name of the Global datastore
String replicationGroupId
The name of the secondary cluster you wish to remove from the Global datastore
String replicationGroupRegion
The AWS region of secondary cluster you wish to remove from the Global datastore
String cacheParameterGroupFamily
Specifies the name of the cache parameter group family to which the engine default parameters apply.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 |
redis5.0 | redis6.x |
String marker
Provides an identifier to allow retrieval of paginated results.
SdkInternalList<T> parameters
Contains a list of engine default parameters.
SdkInternalList<T> cacheNodeTypeSpecificParameters
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
String sourceIdentifier
The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
String sourceType
Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
String message
The text of the event.
Date date
The date and time when the event occurred.
String name
The property being filtered. For example, UserId.
SdkInternalList<T> values
The property values to filter on. For example, "user-123".
String globalReplicationGroupId
The name of the Global datastore
String globalReplicationGroupDescription
The optional description of the Global datastore
String status
The status of the Global datastore
String cacheNodeType
The cache node type of the Global datastore
String engine
The Elasticache engine. For Redis only.
String engineVersion
The Elasticache Redis engine version.
SdkInternalList<T> members
The replication groups that comprise the Global datastore.
Boolean clusterEnabled
A flag that indicates whether the Global datastore is cluster enabled.
SdkInternalList<T> globalNodeGroups
Indicates the slot configuration and global identifier for each slice group.
Boolean authTokenEnabled
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
Boolean transitEncryptionEnabled
A flag that enables in-transit encryption when set to true. You cannot modify the value of
TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster
you must set TransitEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Boolean atRestEncryptionEnabled
A flag that enables encryption at rest when set to true.
You cannot modify the value of 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.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
String aRN
The ARN (Amazon Resource Name) of the global replication group.
String replicationGroupId
The replication group id of the Global datastore member.
String replicationGroupRegion
The AWS region of the Global datastore member.
String role
Indicates the role of the replication group, primary or secondary.
String automaticFailover
Indicates whether automatic failover is enabled for the replication group.
String status
The status of the membership of the replication group.
String globalReplicationGroupId
The name of the Global datastore
Integer nodeGroupCount
The number of node groups you wish to add
SdkInternalList<T> regionalConfigurations
Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global datastore
Boolean applyImmediately
Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
String replicationGroupId
The id of the replication group to which you want to add replica nodes.
Integer newReplicaCount
The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
SdkInternalList<T> replicaConfiguration
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode
enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
NodeGroupId, and PreferredAvailabilityZones.
Boolean applyImmediately
If True, the number of replica nodes is increased immediately. ApplyImmediately=False
is not currently supported.
String deliveryStream
The name of the Kinesis Data Firehose delivery stream.
String cacheClusterId
The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
String replicationGroupId
The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
SdkInternalList<T> scaleUpModifications
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
When scaling up a Redis cluster or replication group using ModifyCacheCluster or
ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
SdkInternalList<T> scaleDownModifications
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
String resourceName
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
SdkInternalList<T> tagList
A list of tags as key-value pairs.
String logType
Refers to slow-log.
String destinationType
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails destinationDetails
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
String logFormat
Returns the log format, either JSON or TEXT.
String status
Returns the log delivery configuration status. Values are one of enabling | disabling |
modifying | active | error
String message
Returns an error message for the log delivery configuration.
String logType
Refers to slow-log.
String destinationType
Specify either cloudwatch-logs or kinesis-firehose as the destination type.
DestinationDetails destinationDetails
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
String logFormat
Specifies either JSON or TEXT
Boolean enabled
Specify if log delivery is enabled. Default true.
String cacheClusterId
The cluster identifier. This value is stored as a lowercase string.
Integer numCacheNodes
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 Redis, 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.
SdkInternalList<T> cacheNodeIdsToRemove
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.
String aZMode
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.
SdkInternalList<T> newAvailabilityZones
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.
SdkInternalList<T> cacheSecurityGroupNames
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".
SdkInternalList<T> securityGroupIds
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).
String preferredMaintenanceWindow
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
String notificationTopicArn
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.
String cacheParameterGroupName
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.
String notificationTopicStatus
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active
.
Valid values: active | inactive
Boolean applyImmediately
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.
Valid values: true | false
Default: false
String engineVersion
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.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
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.
String snapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
String cacheNodeType
A valid cache node type that you want to scale this cluster up to.
String authToken
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.
String authTokenUpdateStrategy
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
SdkInternalList<T> logDeliveryConfigurations
Specifies the destination, format and type of the logs.
String cacheParameterGroupName
The name of the cache parameter group to modify.
SdkInternalList<T> parameterNameValues
An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
String cacheParameterGroupName
The name of the cache parameter group.
String cacheSubnetGroupName
The name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
A description of the cache subnet group.
SdkInternalList<T> subnetIds
The EC2 subnet IDs for the cache subnet group.
String globalReplicationGroupId
The name of the Global datastore
Boolean applyImmediately
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
String cacheNodeType
A valid cache node type that you want to scale this Global datastore to.
String engineVersion
The upgraded version of the cache engine to be run on the clusters in the Global datastore.
String cacheParameterGroupName
The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
String globalReplicationGroupDescription
A description of the Global datastore
Boolean automaticFailoverEnabled
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
String replicationGroupId
The identifier of the replication group to modify.
String replicationGroupDescription
A description for the replication group. Maximum length is 255 characters.
String primaryClusterId
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
String snapshottingClusterId
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.
Boolean automaticFailoverEnabled
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
Boolean multiAZEnabled
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String nodeGroupId
Deprecated. This parameter is not used.
SdkInternalList<T> cacheSecurityGroupNames
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
SdkInternalList<T> securityGroupIds
Specifies the VPC Security Groups associated with the clusters in the replication group.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
String preferredMaintenanceWindow
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
String notificationTopicArn
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 replication group owner.
String cacheParameterGroupName
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is
asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is
specified as true for this request.
String notificationTopicStatus
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the
status is active.
Valid values: active | inactive
Boolean applyImmediately
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 replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance reboot,
or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
String engineVersion
The upgraded version of the cache engine to be run on the clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
The number of days for which ElastiCache retains automatic node group (shard) 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.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
String snapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard)
specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
String cacheNodeType
A valid cache node type that you want to scale this replication group to.
String authToken
Reserved parameter. The password used to access a password protected server. This parameter must be specified
with the auth-token-update-strategy 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.
String authTokenUpdateStrategy
Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
SdkInternalList<T> userGroupIdsToAdd
The user group you are associating with the replication group.
SdkInternalList<T> userGroupIdsToRemove
The user group to remove, meaning the users in the group no longer can access the replication group.
Boolean removeUserGroups
Removes the user groups that can access this replication group.
SdkInternalList<T> logDeliveryConfigurations
Specifies the destination, format and type of the logs.
String replicationGroupId
The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
Integer nodeGroupCount
The number of node groups (shards) that results from the modification of the shard configuration.
Boolean applyImmediately
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for
this parameter is true.
Value: true
SdkInternalList<T> reshardingConfiguration
Specifies the preferred availability zones for each node group in the cluster. If the value of
NodeGroupCount is greater than the current number of node groups (shards), you can use this
parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter
ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount is greater than the current
number of node groups (shards).
SdkInternalList<T> nodeGroupsToRemove
If the value of NodeGroupCount is less than the current number of node groups (shards), then either
NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove
is a list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the
cluster.
SdkInternalList<T> nodeGroupsToRetain
If the value of NodeGroupCount is less than the current number of node groups (shards), then either
NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain
is a list of NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by
NodeGroupsToRetain from the cluster.
String userGroupId
The ID of the user group.
SdkInternalList<T> userIdsToAdd
The list of user IDs to add to the user group.
SdkInternalList<T> userIdsToRemove
The list of user IDs to remove from the user group.
String userGroupId
The ID of the user group.
String status
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
String engine
The current supported value is Redis.
SdkInternalList<T> userIds
The list of user IDs that belong to the user group.
UserGroupPendingChanges pendingChanges
A list of updates being applied to the user groups.
SdkInternalList<T> replicationGroups
A list of replication groups that the user group can access.
String aRN
The Amazon Resource Name (ARN) of the user group.
String userId
The ID of the user.
String accessString
Access permissions string used for this user.
String appendAccessString
Adds additional user permissions to the access string.
SdkInternalList<T> passwords
The passwords belonging to the user. You are allowed up to two.
Boolean noPasswordRequired
Indicates no password is required for the user.
String userId
The ID of the user.
String userName
The username of the user.
String status
Indicates the user status. Can be "active", "modifying" or "deleting".
String engine
The current supported value is Redis.
String accessString
Access permissions string used for this user.
SdkInternalList<T> userGroupIds
Returns a list of the user group IDs the user belongs to.
Authentication authentication
Denotes whether the user requires a password to authenticate.
String aRN
The Amazon Resource Name (ARN) of the user.
String nodeGroupId
The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
String status
The current state of this replication group - creating, available,
modifying, deleting.
Endpoint primaryEndpoint
The endpoint of the primary node in this node group (shard).
Endpoint readerEndpoint
The endpoint of the replica nodes in this node group (shard).
String slots
The keyspace for this node group (shard).
SdkInternalList<T> nodeGroupMembers
A list containing information about individual nodes within the node group (shard).
String nodeGroupId
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
String slots
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is
in the format startkey-endkey.
Example: "0-3999"
Integer replicaCount
The number of read replica nodes in this node group (shard).
String primaryAvailabilityZone
The Availability Zone where the primary node of this node group (shard) is launched.
SdkInternalList<T> replicaAvailabilityZones
A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must
match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
String primaryOutpostArn
The outpost ARN of the primary node.
SdkInternalList<T> replicaOutpostArns
The outpost ARN of the node replicas.
String cacheClusterId
The ID of the cluster to which the node belongs.
String cacheNodeId
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
Endpoint readEndpoint
The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
String preferredAvailabilityZone
The name of the Availability Zone in which the node is located.
String preferredOutpostArn
The outpost ARN of the node group member.
String currentRole
The role that is currently assigned to the node - primary or replica. This member is
only applicable for Redis (cluster mode disabled) replication groups.
String cacheClusterId
The cache cluster ID
String cacheNodeId
The node ID of the cache cluster
String nodeUpdateStatus
The update status of the node
Date nodeDeletionDate
The deletion date of the node
Date nodeUpdateStartDate
The start date of the update for a node
Date nodeUpdateEndDate
The end date of the update for a node
String nodeUpdateInitiatedBy
Reflects whether the update was initiated by the customer or automatically applied
Date nodeUpdateInitiatedDate
The date when the update is triggered
Date nodeUpdateStatusModifiedDate
The date when the NodeUpdateStatus was last modified
String nodeGroupId
The ID of the node group
SdkInternalList<T> nodeGroupMemberUpdateStatus
The status of the service update on the node group member
String cacheClusterId
A unique identifier for the source cluster.
String nodeGroupId
A unique identifier for the source node group (shard).
String cacheNodeId
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration nodeGroupConfiguration
The configuration for the source node group (shard).
String cacheSize
The size of the cache on the source cache node.
Date cacheNodeCreateTime
The date and time when the cache node was created in the source cluster.
Date snapshotCreateTime
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
String parameterName
The name of the parameter.
String parameterValue
The value of the parameter.
String description
A description of the parameter.
String source
The source of the parameter.
String dataType
The valid data type for the parameter.
String allowedValues
The valid range of values for the parameter.
Boolean isModifiable
Indicates whether (true) or not (false) the parameter can be modified. Some parameters
have security or operational implications that prevent them from being changed.
String minimumEngineVersion
The earliest cache engine version to which the parameter can apply.
String changeType
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
String logType
Refers to slow-log.
String destinationType
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails destinationDetails
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
String logFormat
Returns the log format, either JSON or TEXT
Integer numCacheNodes
The new number of cache nodes for the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
SdkInternalList<T> cacheNodeIdsToRemove
A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
String engineVersion
The new cache engine version that the cluster runs.
String cacheNodeType
The cache node type that this cluster or replication group is scaled to.
String authTokenStatus
The auth token status
SdkInternalList<T> logDeliveryConfigurations
The log delivery configurations being modified
String replicationGroupId
The ID of the replication group
String cacheClusterId
The ID of the cache cluster
String serviceUpdateName
The unique ID of the service update
String updateActionStatus
The status of the update action on the Redis cluster
String reservedCacheNodesOfferingId
The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedCacheNodeId
A customer-specified identifier to track this reservation.
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID
Integer cacheNodeCount
The number of cache node instances to reserve.
Default: 1
SdkInternalList<T> tags
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
String cacheClusterId
The cluster identifier. This parameter is stored as a lowercase string.
SdkInternalList<T> cacheNodeIdsToReboot
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.
String replicationGroupId
The name of the secondary cluster
String replicationGroupRegion
The AWS region where the cluster is stored
SdkInternalList<T> reshardingConfiguration
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the
resharded cluster.
String resourceName
The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
SdkInternalList<T> tagKeys
A list of TagKeys identifying the tags you want removed from the named resource.
SdkInternalList<T> tagList
A list of tags as key-value pairs.
String replicationGroupId
The identifier for the replication group.
String description
The user supplied description of the replication group.
GlobalReplicationGroupInfo globalReplicationGroupInfo
The name of the Global datastore and role of this replication group in the Global datastore.
String status
The current state of this replication group - creating, available,
modifying, deleting, create-failed, snapshotting.
ReplicationGroupPendingModifiedValues pendingModifiedValues
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
SdkInternalList<T> memberClusters
The names of all the cache clusters that are part of this replication group.
SdkInternalList<T> nodeGroups
A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
String snapshottingClusterId
The cluster ID that is used as the daily snapshot source for the replication group.
String automaticFailover
Indicates the status of automatic failover for this Redis replication group.
String multiAZ
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
Endpoint configurationEndpoint
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Integer snapshotRetentionLimit
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.
String snapshotWindow
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.
Boolean clusterEnabled
A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values: true | false
String cacheNodeType
The name of the compute and memory capacity node type for each node in the replication group.
Boolean authTokenEnabled
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
Date authTokenLastModifiedDate
The date the auth token was last modified
Boolean transitEncryptionEnabled
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version
3.2.6, 4.x or later.
Default: false
Boolean atRestEncryptionEnabled
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
encryption at-rest 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 version
3.2.6, 4.x or later.
Default: false
SdkInternalList<T> memberClustersOutpostArns
The outpost ARNs of the replication group's member clusters.
String kmsKeyId
The ID of the KMS key used to encrypt the disk in the cluster.
String aRN
The ARN (Amazon Resource Name) of the replication group.
SdkInternalList<T> userGroupIds
The list of user group IDs that have access to the replication group.
SdkInternalList<T> logDeliveryConfigurations
Returns the destination, format and type of the logs.
String primaryClusterId
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during
the next maintenance window.
String automaticFailoverStatus
Indicates the status of automatic failover for this Redis replication group.
ReshardingStatus resharding
The status of an online resharding operation.
String authTokenStatus
The auth token status
UserGroupsUpdateStatus userGroups
The user groups being modified.
SdkInternalList<T> logDeliveryConfigurations
The log delivery configurations being modified
String reservedCacheNodeId
The unique identifier for the reservation.
String reservedCacheNodesOfferingId
The offering identifier.
String cacheNodeType
The cache node type for the reserved cache nodes.
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
Date startTime
The time the reservation started.
Integer duration
The duration of the reservation in seconds.
Double fixedPrice
The fixed price charged for this reserved cache node.
Double usagePrice
The hourly price charged for this reserved cache node.
Integer cacheNodeCount
The number of cache nodes that have been reserved.
String productDescription
The description of the reserved cache node.
String offeringType
The offering type of this reserved cache node.
String state
The state of the reserved cache node.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved cache node.
String reservationARN
The Amazon Resource Name (ARN) of the reserved cache node.
Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
String reservedCacheNodesOfferingId
A unique identifier for the reserved cache node offering.
String cacheNodeType
The cache node type for the reserved cache node.
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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
Integer duration
The duration of the offering. in seconds.
Double fixedPrice
The fixed price charged for this offering.
Double usagePrice
The hourly price charged for this offering.
String productDescription
The cache engine used by the offering.
String offeringType
The offering type.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved cache node.
String cacheParameterGroupName
The name of the cache parameter group to reset.
Boolean resetAllParameters
If true, all parameters in the cache parameter group are reset to their default values. If
false, only the parameters listed by ParameterNameValues are reset to their default
values.
Valid values: true | false
SdkInternalList<T> parameterNameValues
An array of parameter names to reset to their default values. If ResetAllParameters is
true, do not use ParameterNameValues. If ResetAllParameters is
false, you must specify the name of at least one parameter to reset.
String cacheParameterGroupName
The name of the cache parameter group.
String nodeGroupId
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
SdkInternalList<T> preferredAvailabilityZones
A list of preferred availability zones for the nodes in this cluster.
SlotMigration slotMigration
Represents the progress of an online resharding operation.
String cacheSecurityGroupName
The name of the cache security group to revoke ingress from.
String eC2SecurityGroupName
The name of the Amazon EC2 security group to revoke access from.
String eC2SecurityGroupOwnerId
The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
String serviceUpdateName
The unique ID of the service update
Date serviceUpdateReleaseDate
The date when the service update is initially available
Date serviceUpdateEndDate
The date after which the service update is no longer available
String serviceUpdateSeverity
The severity of the service update
Date serviceUpdateRecommendedApplyByDate
The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
String serviceUpdateStatus
The status of the service update
String serviceUpdateDescription
Provides details of the service update
String serviceUpdateType
Reflects the nature of the service update
String engine
The Elasticache engine to which the update applies. Either Redis or Memcached
String engineVersion
The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
Boolean autoUpdateAfterRecommendedApplyByDate
Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
String estimatedUpdateTime
The estimated length of time the service update will take
Double progressPercentage
The percentage of the slot migration that is complete.
String snapshotName
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
String replicationGroupId
The unique identifier of the source replication group.
String replicationGroupDescription
A description of the source replication group.
String cacheClusterId
The user-supplied identifier of the source cluster.
String snapshotStatus
The status of the snapshot. Valid values: creating | available | restoring
| copying | deleting.
String snapshotSource
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (
manual).
String cacheNodeType
The name of the compute and memory capacity node type for the source 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:
M6g node types (available only for Redis 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
For region availability, see Supported Node Types
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
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)
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)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis 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
For region availability, see Supported Node Types
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)
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.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis
version 2.8.22 and later.
String engine
The name of the cache engine (memcached or redis) used by the source cluster.
String engineVersion
The version of the cache engine version that is used by the source cluster.
Integer numCacheNodes
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
String preferredAvailabilityZone
The name of the Availability Zone in which the source cluster is located.
String preferredOutpostArn
The ARN (Amazon Resource Name) of the preferred outpost.
Date cacheClusterCreateTime
The date and time when the source cluster was created.
String preferredMaintenanceWindow
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
String topicArn
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Integer port
The port number used by each cache nodes in the source cluster.
String cacheParameterGroupName
The cache parameter group that is associated with the source cluster.
String cacheSubnetGroupName
The name of the cache subnet group associated with the source cluster.
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the
snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted
using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
String snapshotWindow
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
Integer numNodeGroups
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
String automaticFailover
Indicates the status of automatic failover for the source Redis replication group.
SdkInternalList<T> nodeSnapshots
A list of the cache nodes in the source cluster.
String kmsKeyId
The ID of the KMS key used to encrypt the snapshot.
String aRN
The ARN (Amazon Resource Name) of the snapshot.
String replicationGroupId
The ID of the replication group to which data should be migrated.
SdkInternalList<T> customerNodeEndpointList
List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
String subnetIdentifier
The unique identifier for the subnet.
AvailabilityZone subnetAvailabilityZone
The Availability Zone associated with the subnet.
SubnetOutpost subnetOutpost
The outpost ARN of the subnet.
String subnetOutpostArn
The outpost ARN of the subnet.
String replicationGroupId
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
String nodeGroupId
The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
String replicationGroupId
The replication group ID
String cacheClusterId
The ID of the cache cluster
String serviceUpdateName
The unique ID of the service update
String errorType
The error type for requests that are not processed
String errorMessage
The error message that describes the reason the request was not processed
String replicationGroupId
The ID of the replication group
String cacheClusterId
The ID of the cache cluster
String serviceUpdateName
The unique ID of the service update
Date serviceUpdateReleaseDate
The date the update is first available
String serviceUpdateSeverity
The severity of the service update
String serviceUpdateStatus
The status of the service update
Date serviceUpdateRecommendedApplyByDate
The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
String serviceUpdateType
Reflects the nature of the service update
Date updateActionAvailableDate
The date that the service update is available to a replication group
String updateActionStatus
The status of the update action
String nodesUpdated
The progress of the service update on the replication group
Date updateActionStatusModifiedDate
The date when the UpdateActionStatus was last modified
String slaMet
If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
SdkInternalList<T> nodeGroupUpdateStatus
The status of the service update on the node group
SdkInternalList<T> cacheNodeUpdateStatus
The status of the service update on the cache node
String estimatedUpdateTime
The estimated length of time for the update to complete
String engine
The Elasticache engine to which the update applies. Either Redis or Memcached
String userId
The ID of the user.
String userName
The username of the user.
String status
Indicates the user status. Can be "active", "modifying" or "deleting".
String engine
The current supported value is Redis.
String accessString
Access permissions string used for this user.
SdkInternalList<T> userGroupIds
Returns a list of the user group IDs the user belongs to.
Authentication authentication
Denotes whether the user requires a password to authenticate.
String aRN
The Amazon Resource Name (ARN) of the user.
String userGroupId
The ID of the user group.
String status
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
String engine
The current supported value is Redis.
SdkInternalList<T> userIds
The list of user IDs that belong to the user group.
UserGroupPendingChanges pendingChanges
A list of updates being applied to the user groups.
SdkInternalList<T> replicationGroups
A list of replication groups that the user group can access.
String aRN
The Amazon Resource Name (ARN) of the user group.
SdkInternalList<T> userIdsToRemove
The list of user IDs to remove.
SdkInternalList<T> userIdsToAdd
The list of user IDs to add.
SdkInternalList<T> userGroupIdsToAdd
The list of user group IDs to add.
SdkInternalList<T> userGroupIdsToRemove
The list of user group IDs to remove.
Copyright © 2021. All rights reserved.