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
.
For more information on ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces.
com.amazonaws.internal.SdkInternalList<T> tags
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of cost allocation tags as key-value pairs.
String cacheSecurityGroupName
The cache security group which will allow 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.
String cacheClusterId
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
Endpoint configurationEndpoint
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 cache cluster.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
The name of the cache engine (memcached or redis) to be used for this cache cluster.
String engineVersion
The version of the cache engine that is used in this cache cluster.
String cacheClusterStatus
The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
Integer numCacheNodes
The number of cache nodes in the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
Date cacheClusterCreateTime
The date and time when the cache cluster was created.
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.SdkInternalList<T> cacheSecurityGroups
A list of cache security group elements, composed of name and status sub-elements.
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
The name of the cache subnet group associated with the cache cluster.
com.amazonaws.internal.SdkInternalList<T> cacheNodes
A list of cache nodes that are members of the cache cluster.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
com.amazonaws.internal.SdkInternalList<T> securityGroups
A list of VPC Security Groups associated with the cache cluster.
String replicationGroupId
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
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.
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.
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, then this node is not associated with a primary cache cluster.
String customerAvailabilityZone
The Availability Zone where this node was created and now resides.
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.
com.amazonaws.internal.SdkInternalList<T> cacheNodeTypeSpecificValues
A list of cache node types and their corresponding values for this parameter.
String changeType
ChangeType indicates whether a change to the parameter will be 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 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.
String description
The description for this cache parameter group.
String cacheParameterGroupName
The name of the cache parameter group.
String parameterApplyStatus
The status of parameter updates.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> eC2SecurityGroups
A list of Amazon EC2 security groups that are associated with this 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.
com.amazonaws.internal.SdkInternalList<T> subnets
A list of subnets associated with the cache subnet group.
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.
Error Message
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
String targetBucket
The Amazon S3 bucket to which the snapshot will be 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.
Error Messages:
You could receive one of the following error messages.
Erorr Messages
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions permissions on the bucket.
Error Message: The S3 bucket %s is outside of the region.
Solution: Before exporting your snapshot, create a new Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
String cacheClusterId
The node group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 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 cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be 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 node group 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 cache clusters.
If the AZMode
and PreferredAvailabilityZones
are not specified, ElastiCache assumes single-az
mode.
String preferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster will be created.
All nodes belonging to this Memcached cache 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.
com.amazonaws.internal.SdkInternalList<T> preferredAvailabilityZones
A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
If you are creating your cache 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.
Example: One Memcached node in each of three different Availability
Zones:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a
Integer numCacheNodes
The initial number of cache nodes that the cache cluster will have.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are:
memcached
| redis
String engineVersion
The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.
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 cache 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 cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.
String cacheSubnetGroupName
The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.SdkInternalList<T> cacheSecurityGroupNames
A list of security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.SdkInternalList<T> tags
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
com.amazonaws.internal.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 will be used to populate the node group. 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 snapshot from which to restore data into the new node
group. The snapshot status changes to restoring
while the
new node group 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 cache
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:05:00-sun:09:00
Integer port
The port number on which each of the cache nodes will accept connections.
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic snapshots
before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, then a snapshot that was taken
today will be 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 will begin taking a daily snapshot of your node group.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the Engine
parameter is redis
.
String cacheParameterGroupName
A user-specified name for the cache parameter group.
String cacheParameterGroupFamily
The name of the cache parameter group family the cache parameter group can be used with.
Valid values are: memcached1.4
| redis2.6
|
redis2.8
String description
A user-specified description for the cache parameter group.
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.
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.
com.amazonaws.internal.SdkInternalList<T> subnetIds
A list of VPC subnet IDs for the cache subnet group.
String replicationGroupId
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 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 primaryClusterId
The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters is specified.
Boolean automaticFailoverEnabled
Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.
If true
, Multi-AZ is enabled for this replication group. If
false
, Multi-AZ is disabled for this replication group.
Default: false
ElastiCache Multi-AZ replication groups is not supported on:
Redis versions earlier than 2.8.6.
T1 and T2 cache node types.
Integer numCacheClusters
The number of cache clusters this replication group will initially have.
If Multi-AZ is enabled
, the value of this parameter
must be at least 2.
The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
com.amazonaws.internal.SdkInternalList<T> preferredCacheClusterAZs
A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache 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.
Example: One Redis cache cluster in each of three availability zones.
PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c
String cacheNodeType
The compute and memory capacity of the nodes in the node group.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
The name of the cache engine to be used for the cache clusters in this replication group.
Default: redis
String engineVersion
The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.
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 cache 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.
String cacheSubnetGroupName
The name of the cache subnet group to be used for the replication group.
com.amazonaws.internal.SdkInternalList<T> cacheSecurityGroupNames
A list of cache security group names to associate with this replication group.
com.amazonaws.internal.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 (VPC).
com.amazonaws.internal.SdkInternalList<T> tags
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
com.amazonaws.internal.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 will be used to populate the node group. 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 snapshot from which to restore data into the new node
group. The snapshot status changes to restoring
while the
new node group 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 cache
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:05:00-sun:09:00
Integer port
The port number on which each member of the replication group will accept connections.
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
The Amazon SNS topic owner must be the same as the cache cluster owner.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic snapshots
before deleting them. For example, if you set
SnapshotRetentionLimit
to 5, then a snapshot that was taken
today will be 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 will begin taking a daily snapshot of your node group.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
This parameter is only valid if the Engine
parameter is
redis
.
String cacheClusterId
The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
String finalSnapshotIdentifier
The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache 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 cache 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 will be deleted, but the primary node will be retained.
String finalSnapshotIdentifier
The name of a final node group 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 cluster is immediately deleted.
String snapshotName
The name of the snapshot to be deleted.
String cacheClusterId
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache 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 action. 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.
String marker
Provides an identifier to allow retrieval of paginated results.
com.amazonaws.internal.SdkInternalList<T> cacheClusters
A list of cache clusters. Each item in the list contains detailed information about one cache 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.
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 action. 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.
com.amazonaws.internal.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 action. 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.
com.amazonaws.internal.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 brecords 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 action. 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.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter instances.
com.amazonaws.internal.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 action. 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.
com.amazonaws.internal.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 action. 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.
com.amazonaws.internal.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
| redis2.6
| redis2.8
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 action. 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 will be returned. If not specified, then 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.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
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 action. 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.
com.amazonaws.internal.SdkInternalList<T> events
A list of events. Each element in the list contains detailed information about one event.
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 action. 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.
com.amazonaws.internal.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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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"
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 action. 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.
com.amazonaws.internal.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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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"
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 action. 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.
com.amazonaws.internal.SdkInternalList<T> reservedCacheNodes
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
String cacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.
String snapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be 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 action. 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.
String marker
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
com.amazonaws.internal.SdkInternalList<T> snapshots
A list of snapshots. Each item in the list contains detailed information about one snapshot.
String cacheParameterGroupFamily
Specifies the name of the cache parameter group family to which the engine default parameters apply.
String marker
Provides an identifier to allow retrieval of paginated results.
com.amazonaws.internal.SdkInternalList<T> parameters
Contains a list of engine default parameters.
com.amazonaws.internal.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 cache cluster level, the identifier would be the name of the cache cluster.
String sourceType
Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.
String message
The text of the event.
Date dateValue
The date and time when the event occurred.
String cacheClusterId
The name of the cache 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 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.
com.amazonaws.internal.SdkInternalList<T> scaleUpModifications
A string list, each element of which specifies a cache node type which you can use to scale your cache 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.
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 on ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of cost allocation tags as key-value pairs.
String cacheClusterId
The cache cluster identifier. This value is stored as a lowercase string.
Integer numCacheNodes
The number of cache nodes that the cache 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), then more nodes will be added. If the value
is less than the number of existing cache nodes, then nodes will be
removed. If the value is equal to the number of current cache nodes, then
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 20.
Adding or removing Memcached cache nodes can be applied immediately or as
a pending action. See ApplyImmediately
.
A pending action 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 actions to modify the number of cache nodes in the cluster. For
example, a request to remove 2 nodes would override a previous pending
action to remove 3 nodes. Similarly, a request to add 2 nodes would
override a previous pending action 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 action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions 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
cache cluster.
com.amazonaws.internal.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 ModifyCacheCluser
call is
5, you must list 2 (7 - 5) cache node IDs to remove.
String aZMode
Specifies whether the new nodes in this Memcached cache 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 cache clusters.
You cannot specify single-az
if the Memcached cache 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 will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
com.amazonaws.internal.SdkInternalList<T> newAvailabilityZones
The list of Availability Zones where the new Memcached cache nodes will be 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.
This option is only supported on Memcached clusters.
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 actions. Specify
NumCacheNodes=3
to cancel all pending actions.
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.
Example:
NewAvailabilityZones.member.1=us-west-2a&NewAvailabilityZones.member.2=us-west-2b&NewAvailabilityZones.member.3=us-west-2c
com.amazonaws.internal.SdkInternalList<T> cacheSecurityGroupNames
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the cache cluster owner.
String cacheParameterGroupName
The name of the cache parameter group to apply to this cache 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 cache cluster.
If false
, then changes to the cache 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 cache 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of your cache cluster.
String cacheNodeType
A valid cache node type that you want to scale this cache cluster to. The
value of this parameter must be one of the ScaleUpModifications
values returned by the ListAllowedCacheNodeTypeModification
action.
String cacheParameterGroupName
The name of the cache parameter group to modify.
com.amazonaws.internal.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 for the cache subnet group.
com.amazonaws.internal.SdkInternalList<T> subnetIds
The EC2 subnet IDs for the cache subnet group.
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
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
String snapshottingClusterId
The cache cluster ID that will be used as the daily snapshot source for the replication group.
Boolean automaticFailoverEnabled
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true
| false
ElastiCache Multi-AZ replication groups are not supported on:
Redis versions earlier than 2.8.6.
T1 and T2 cache node types.
com.amazonaws.internal.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 cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be 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
, then 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 cache 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 will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String cacheNodeType
A valid cache node type that you want to scale this replication group to.
The value of this parameter must be one of the
ScaleUpModifications values returned by the
ListAllowedCacheNodeTypeModification
action.
String nodeGroupId
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
String status
The current state of this replication group - creating, available, etc.
Endpoint primaryEndpoint
com.amazonaws.internal.SdkInternalList<T> nodeGroupMembers
A list containing information about individual nodes within the node group.
String cacheClusterId
The ID of the cache cluster to which the node belongs.
String cacheNodeId
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
Endpoint readEndpoint
String preferredAvailabilityZone
The name of the Availability Zone in which the node is located.
String currentRole
The role that is currently assigned to the node - primary or replica.
String cacheNodeId
The cache node identifier for the node in the source cache cluster.
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 cache 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
ChangeType indicates whether a change to the parameter will be 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.
Integer numCacheNodes
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
com.amazonaws.internal.SdkInternalList<T> cacheNodeIdsToRemove
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
String engineVersion
The new cache engine version that the cache cluster will run.
String cacheNodeType
The cache node type that this cache cluster or replication group will be scaled to.
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
String cacheClusterId
The cache cluster identifier. This parameter is stored as a lowercase string.
com.amazonaws.internal.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 cache cluster, specify all of the cache node IDs.
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 on ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces.
com.amazonaws.internal.SdkInternalList<T> tagKeys
A list of TagKeys
identifying the tags you want removed from
the named resource. For example, TagKeys.member.1=Region
removes the cost allocation tag with the key name Region
from the resource named by the ResourceName parameter.
com.amazonaws.internal.SdkInternalList<T> tagList
A list of cost allocation tags as key-value pairs.
String replicationGroupId
The identifier for the replication group.
String description
The description of the replication group.
String status
The current state of this replication group - creating, available, etc.
ReplicationGroupPendingModifiedValues pendingModifiedValues
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
com.amazonaws.internal.SdkInternalList<T> memberClusters
The names of all the cache clusters that are part of this replication group.
com.amazonaws.internal.SdkInternalList<T> nodeGroups
A single element list with information about the nodes in the replication group.
String snapshottingClusterId
The cache cluster ID that is used as the daily snapshot source for the replication group.
String automaticFailover
Indicates the status of Multi-AZ for this replication group.
ElastiCache Multi-AZ replication groups are not supported on:
Redis versions earlier than 2.8.6.
T1 and T2 cache node types.
String primaryClusterId
The primary cluster ID which will be applied immediately (if
--apply-immediately
was specified), or during the next
maintenance window.
String automaticFailoverStatus
Indicates the status of Multi-AZ for this replication group.
ElastiCache Multi-AZ replication groups are not supported on:
Redis versions earlier than 2.8.6.
T1 and T2 cache node types.
String reservedCacheNodeId
The unique identifier for the reservation.
String reservedCacheNodesOfferingId
The offering identifier.
String cacheNodeType
The cache node type for the reserved cache nodes.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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.
com.amazonaws.internal.SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved cache node.
String reservedCacheNodesOfferingId
A unique identifier for the reserved cache node offering.
String cacheNodeType
The cache node type for the reserved cache node.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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.
com.amazonaws.internal.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 will be reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.
Valid values: true
| false
com.amazonaws.internal.SdkInternalList<T> parameterNameValues
An array of parameter names to reset to their default values. 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 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 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 cacheClusterId
The user-supplied identifier of the source cache 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 cache cluster.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro
,
cache.t2.small
, cache.t2.medium
,
cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
Previous generation: cache.t1.micro
,
cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized:
Current generation: cache.r3.large
,
cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: cache.m2.xlarge
,
cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
String engine
The name of the cache engine (memcached or redis) used by the source cache cluster.
String engineVersion
The version of the cache engine version that is used by the source cache cluster.
Integer numCacheNodes
The number of cache nodes in the source cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
String preferredAvailabilityZone
The name of the Availability Zone in which the source cache cluster is located.
Date cacheClusterCreateTime
The date and time when the source cache cluster was created.
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
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:05:00-sun:09:00
String topicArn
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Integer port
The port number used by each cache nodes in the source cache cluster.
String cacheParameterGroupName
The cache parameter group that is associated with the source cache cluster.
String cacheSubnetGroupName
The name of the cache subnet group associated with the source cache cluster.
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
Integer snapshotRetentionLimit
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
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 cache cluster.
com.amazonaws.internal.SdkInternalList<T> nodeSnapshots
A list of the cache nodes in the source cache cluster.
String subnetIdentifier
The unique identifier for the subnet.
AvailabilityZone subnetAvailabilityZone
The Availability Zone associated with the subnet.
Copyright © 2016. All rights reserved.