String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String name
String cacheClusterId
Endpoint configurationEndpoint
String clientDownloadLandingPage
String cacheNodeType
String engine
String engineVersion
String cacheClusterStatus
Integer numCacheNodes
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
String cacheSubnetGroupName
ListWithAutoConstructFlag<T> cacheNodes
Boolean autoMinorVersionUpgrade
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.ListWithAutoConstructFlag<T> securityGroups
String replicationGroupId
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example:
05:00-09:00
String engine
String engineVersion
String cacheParameterGroupFamily
String cacheEngineDescription
String cacheEngineVersionDescription
String cacheNodeId
String cacheNodeStatus
Date cacheNodeCreateTime
Endpoint endpoint
String parameterGroupStatus
String sourceCacheNodeId
String customerAvailabilityZone
String parameterName
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
String cacheParameterGroupName
String cacheParameterGroupFamily
String description
String cacheParameterGroupName
String parameterApplyStatus
ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String ownerId
String cacheSecurityGroupName
String description
ListWithAutoConstructFlag<T> eC2SecurityGroups
String cacheSubnetGroupName
String cacheSubnetGroupDescription
String vpcId
ListWithAutoConstructFlag<T> subnets
String cacheClusterId
Constraints:
String replicationGroupId
Integer numCacheNodes
For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .
For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.
String cacheNodeType
Valid cache types
cache.t1.micro |
cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge
| cache.m3.2xlarge
cache.m1.medium | cache.m1.large |
cache.m1.xlarge
cache.c1.xlarge
cache.r3.large | cache.r3.xlarge |
cache.r3.2xlarge | cache.r3.4xlarge | cache.r3.8xlarge
cache.m2.xlarge | cache.m2.2xlarge |
cache.m2.4xlarge
For a complete listing of cache node types and specifications, see Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis and Amazon ElastiCache Product Features and Details.
String engine
Valid values for this parameter are:
memcached
|
redis
String engineVersion
String cacheParameterGroupName
String cacheSubnetGroupName
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC).
ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
ListWithAutoConstructFlag<T> snapshotArns
Here is an example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This
parameter is only valid if the Engine
parameter is
redis
.
String snapshotName
restoring
while
the new cache cluster is being created.String aZMode
This option is only supported for Memcached
cache clusters. AZMode
and
PreferredAvailabilityZones
are not specified, ElastiCache
assumes single-az
mode.
Valid values:
single-az
| cross-az
.
String preferredAvailabilityZone
All cache nodes belonging to this Memcached cache cluster are
placed in the preferred Availability Zone. If you want to create your
cache nodes across multiple Availability Zones, use
PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
ListWithAutoConstructFlag<T> preferredAvailabilityZones
This option is
only supported on Memcached clusters. 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 your cache 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 Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
Integer port
String notificationTopicArn
Boolean autoMinorVersionUpgrade
true
allows these upgrades to occur; false
disables automatic upgrades. Default: true
Integer snapshotRetentionLimit
SnapshotRetentionLimit
to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted. If
you do not specify this parameter, then
SnapshotRetentionLimit
will be set to 0 (i.e., automatic
backups will be disabled for this cache cluster).
String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String cacheParameterGroupName
String cacheParameterGroupFamily
Valid values are: memcached1.4
|
redis2.6
| redis2.8
String description
String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word "Default".
Example:
mysecuritygroup
String description
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
String cacheSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
Constraints:
String primaryClusterId
String replicationGroupDescription
String cacheClusterId
String finalSnapshotIdentifier
String cacheParameterGroupName
String cacheSecurityGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
String replicationGroupId
Boolean retainPrimaryCluster
String finalSnapshotIdentifier
String snapshotName
String cacheClusterId
Integer maxRecords
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
Boolean showCacheNodeInfo
String marker
ListWithAutoConstructFlag<T> cacheClusters
String engine
memcached
|
redis
String engineVersion
Example: 1.4.14
String cacheParameterGroupFamily
Constraints:
Integer maxRecords
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
Boolean defaultOnly
String marker
ListWithAutoConstructFlag<T> cacheEngineVersions
String cacheParameterGroupName
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> cacheParameterGroups
String cacheParameterGroupName
String source
Valid values: user
|
system
| engine-default
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> parameters
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String cacheSecurityGroupName
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> cacheSecurityGroups
String cacheSubnetGroupName
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> cacheSubnetGroups
String cacheParameterGroupFamily
memcached1.4
| redis2.6
|
redis2.8
Integer maxRecords
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
String sourceIdentifier
String sourceType
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
| cache-subnet-group
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
Date startTime
Date endTime
Integer duration
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> events
String replicationGroupId
If you do not specify this parameter, information about all replication groups is returned.
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> replicationGroups
String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
String productDescription
String offeringType
Valid
values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
Integer maxRecords
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
String marker
ListWithAutoConstructFlag<T> reservedCacheNodes
String cacheClusterId
String snapshotName
String snapshotSource
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
Integer maxRecords
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
ListWithAutoConstructFlag<T> snapshots
String cacheParameterGroupFamily
String marker
ListWithAutoConstructFlag<T> parameters
ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
String sourceIdentifier
String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
String message
Date date
String cacheClusterId
Integer numCacheNodes
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 cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
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.
ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
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.
ListWithAutoConstructFlag<T> cacheSecurityGroupNames
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".
ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values:
active
| inactive
Boolean applyImmediately
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. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
String engineVersion
Boolean autoMinorVersionUpgrade
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
String aZMode
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify 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. 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.
ListWithAutoConstructFlag<T> newAvailabilityZones
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:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). 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.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
String cacheParameterGroupName
ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
String cacheSubnetGroupDescription
ListWithAutoConstructFlag<T> subnetIds
String replicationGroupId
String replicationGroupDescription
ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication groups 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".
ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
String preferredMaintenanceWindow
String notificationTopicArn
String cacheParameterGroupName
String notificationTopicStatus
Valid values: active
| inactive
Boolean applyImmediately
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
Boolean autoMinorVersionUpgrade
true
allows these upgrades
to occur; false
disables automatic upgrades.String primaryClusterId
Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
String snapshotWindow
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
String snapshottingClusterId
String nodeGroupId
String status
Endpoint primaryEndpoint
ListWithAutoConstructFlag<T> nodeGroupMembers
String cacheClusterId
String cacheNodeId
Endpoint readEndpoint
String preferredAvailabilityZone
String currentRole
String cacheNodeId
String cacheSize
Date cacheNodeCreateTime
Date snapshotCreateTime
String parameterName
String parameterValue
String description
String source
String dataType
String allowedValues
Boolean isModifiable
true
) or not (false
) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.String minimumEngineVersion
Integer numCacheNodes
ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
String engineVersion
String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedCacheNodeId
Example: myreservationID
Integer cacheNodeCount
Default:
1
String cacheClusterId
ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
String replicationGroupId
String description
String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
ListWithAutoConstructFlag<T> memberClusters
ListWithAutoConstructFlag<T> nodeGroups
String snapshottingClusterId
String primaryClusterId
--apply-immediately
was specified), or during the next
maintenance window.String reservedCacheNodeId
String reservedCacheNodesOfferingId
String cacheNodeType
Date startTime
Integer duration
Double fixedPrice
Double usagePrice
Integer cacheNodeCount
String productDescription
String offeringType
String state
ListWithAutoConstructFlag<T> recurringCharges
String reservedCacheNodesOfferingId
String cacheNodeType
Integer duration
Double fixedPrice
Double usagePrice
String productDescription
String offeringType
ListWithAutoConstructFlag<T> recurringCharges
String cacheParameterGroupName
Boolean resetAllParameters
Valid values: true
| false
ListWithAutoConstructFlag<T> parameterNameValues
String cacheParameterGroupName
String cacheSecurityGroupName
String eC2SecurityGroupName
String eC2SecurityGroupOwnerId
String snapshotName
String cacheClusterId
String snapshotStatus
creating
|
available
| restoring
| copying
| deleting
.String snapshotSource
automated
) or was created manually
(manual
).String cacheNodeType
String engine
String engineVersion
Integer numCacheNodes
String preferredAvailabilityZone
Date cacheClusterCreateTime
String preferredMaintenanceWindow
String topicArn
Integer port
String cacheParameterGroupName
String cacheSubnetGroupName
String vpcId
Boolean autoMinorVersionUpgrade
true
) or not
(false
).Integer snapshotRetentionLimit
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
ListWithAutoConstructFlag<T> nodeSnapshots
String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
Copyright © 2014. All rights reserved.