public interface AmazonElastiCache
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
The AddTagsToResource action adds up to 10 cost allocation tags to
the named resource.
|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
The AuthorizeCacheSecurityGroupIngress action allows network
ingress to a cache security group.
|
Snapshot |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
The CopySnapshot action makes a copy of an existing snapshot.
|
CacheCluster |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
The CreateCacheCluster action creates a cache cluster.
|
CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
The CreateCacheParameterGroup action creates a new cache parameter
group.
|
CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
The CreateCacheSecurityGroup action creates a new cache security
group.
|
CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
The CreateCacheSubnetGroup action creates a new cache subnet
group.
|
ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
The CreateReplicationGroup action creates a replication group.
|
Snapshot |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
The CreateSnapshot action creates a copy of an entire cache
cluster at a specific moment in time.
|
CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
The DeleteCacheCluster action deletes a previously provisioned
cache cluster.
|
DeleteCacheParameterGroupResult |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
The DeleteCacheParameterGroup action deletes the specified cache
parameter group.
|
DeleteCacheSecurityGroupResult |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
The DeleteCacheSecurityGroup action deletes a cache security
group.
|
DeleteCacheSubnetGroupResult |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
The DeleteCacheSubnetGroup action deletes a cache subnet group.
|
ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
The DeleteReplicationGroup action deletes an existing replication
group.
|
Snapshot |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
The DeleteSnapshot action deletes an existing snapshot.
|
DescribeCacheClustersResult |
describeCacheClusters()
Simplified method form for invoking the DescribeCacheClusters operation.
|
DescribeCacheClustersResult |
describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
The DescribeCacheClusters action returns information about all
provisioned cache clusters if no cache cluster identifier is specified,
or about a specific cache cluster if a cache cluster identifier is
supplied.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions()
Simplified method form for invoking the DescribeCacheEngineVersions
operation.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
The DescribeCacheEngineVersions action returns a list of the
available cache engines and their versions.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
Simplified method form for invoking the DescribeCacheParameterGroups
operation.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
The DescribeCacheParameterGroups action returns a list of cache
parameter group descriptions.
|
DescribeCacheParametersResult |
describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
The DescribeCacheParameters action returns the detailed parameter
list for a particular cache parameter group.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups()
Simplified method form for invoking the DescribeCacheSecurityGroups
operation.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
The DescribeCacheSecurityGroups action returns a list of cache
security group descriptions.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
Simplified method form for invoking the DescribeCacheSubnetGroups
operation.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
The DescribeCacheSubnetGroups action returns a list of cache
subnet group descriptions.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
The DescribeEngineDefaultParameters action returns the default
engine and system parameter information for the specified cache engine.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
The DescribeEvents action returns events related to cache
clusters, cache security groups, and cache parameter groups.
|
DescribeReplicationGroupsResult |
describeReplicationGroups()
Simplified method form for invoking the DescribeReplicationGroups
operation.
|
DescribeReplicationGroupsResult |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
The DescribeReplicationGroups action returns information about a
particular replication group.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
Simplified method form for invoking the DescribeReservedCacheNodes
operation.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
The DescribeReservedCacheNodes action returns information about
reserved cache nodes for this account, or about a specified reserved
cache node.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings()
Simplified method form for invoking the
DescribeReservedCacheNodesOfferings operation.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
The DescribeReservedCacheNodesOfferings action lists available
reserved cache node offerings.
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
The DescribeSnapshots action returns information about cache
cluster snapshots.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications()
Simplified method form for invoking the ListAllowedNodeTypeModifications
operation.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
The
ListAllowedNodeTypeModifications action lists all
available node types that you can scale your Redis cluster's or
replication group's current node type up to. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The ListTagsForResource action lists all cost allocation tags
currently on the named resource.
|
CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
The ModifyCacheCluster action modifies the settings for a cache
cluster.
|
ModifyCacheParameterGroupResult |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
The ModifyCacheParameterGroup action modifies the parameters of a
cache parameter group.
|
CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
The ModifyCacheSubnetGroup action modifies an existing cache
subnet group.
|
ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
The ModifyReplicationGroup action modifies the settings for a
replication group.
|
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
The PurchaseReservedCacheNodesOffering action allows you to
purchase a reserved cache node offering.
|
CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
The RebootCacheCluster action reboots some, or all, of the cache
nodes within a provisioned cache cluster.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
The RemoveTagsFromResource action removes the tags identified by
the
TagKeys list from the named resource. |
ResetCacheParameterGroupResult |
resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
The ResetCacheParameterGroup action modifies the parameters of a
cache parameter group to the engine or system default value.
|
CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
The RevokeCacheSecurityGroupIngress action revokes ingress from a
cache security group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("elasticache.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
static final String ENDPOINT_PREFIX
void setEndpoint(String endpoint)
Callers can pass in just the endpoint (ex:
"elasticache.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "elasticache.us-east-1.amazonaws.com"). If the protocol is
not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex:
"elasticache.us-east-1.amazonaws.com") of the region specific AWS
endpoint this client will communicate with.void setRegion(Region region)
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
The AddTagsToResource action adds up to 10 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used to categorize and track your AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
addTagsToResourceRequest
- Represents the input of an AddTagsToResource action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.TagQuotaPerResourceExceededException
- The request cannot be processed because it would cause the
resource to have more than the allowed number of tags. The
maximum number of tags permitted on a resource is 10.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an
existing resource.CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
The AuthorizeCacheSecurityGroupIngress action allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
authorizeCacheSecurityGroupIngressRequest
- Represents the input of an
AuthorizeCacheSecurityGroupIngress action.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.InvalidCacheSecurityGroupStateException
- The current state of the cache security group does not allow
deletion.AuthorizationAlreadyExistsException
- The specified Amazon EC2 security group is already authorized for
the specified cache security group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest)
The CopySnapshot action makes a copy of an existing snapshot.
Users or groups that have permissions to use the CopySnapshot API can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot API. For more information about using IAM to control the use of ElastiCache APIs, see Exporting Snapshots and Authentication & Access Control.
Erorr Message:
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.
copySnapshotRequest
- Represents the input of a CopySnapshotMessage action.SnapshotAlreadyExistsException
- You already have a snapshot with the given name.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.SnapshotQuotaExceededException
- The request cannot be processed because it would exceed the
maximum number of snapshots.InvalidSnapshotStateException
- The current state of the snapshot does not allow the requested
action to occur.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
createCacheClusterRequest
- Represents the input of a CreateCacheCluster action.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.CacheClusterAlreadyExistsException
- You already have a cache cluster with the given identifier.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified
Availability Zone.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an
existing cache subnet group.ClusterQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache clusters per customer.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes in a single cache cluster.NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes per customer.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.TagQuotaPerResourceExceededException
- The request cannot be processed because it would cause the
resource to have more than the allowed number of tags. The
maximum number of tags permitted on a resource is 10.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
The CreateCacheParameterGroup action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.
createCacheParameterGroupRequest
- Represents the input of a CreateCacheParameterGroup action.CacheParameterGroupQuotaExceededException
- The request cannot be processed because it would exceed the
maximum number of cache security groups.CacheParameterGroupAlreadyExistsException
- A cache parameter group with the requested name already exists.InvalidCacheParameterGroupStateException
- The current state of the cache parameter group does not allow the
requested action to occur.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
The CreateCacheSecurityGroup action creates a new cache security group. Use a cache security group to control access to one or more cache clusters.
Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
createCacheSecurityGroupRequest
- Represents the input of a CreateCacheSecurityGroup action.CacheSecurityGroupAlreadyExistsException
- A cache security group with the specified name already exists.CacheSecurityGroupQuotaExceededException
- The request cannot be processed because it would exceed the
allowed number of cache security groups.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
The CreateCacheSubnetGroup action creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
createCacheSubnetGroupRequest
- Represents the input of a CreateCacheSubnetGroup action.CacheSubnetGroupAlreadyExistsException
- The requested cache subnet group name is already in use by an
existing cache subnet group.CacheSubnetGroupQuotaExceededException
- The request cannot be processed because it would exceed the
allowed number of cache subnet groups.CacheSubnetQuotaExceededException
- The request cannot be processed because it would exceed the
allowed number of subnets in a cache subnet group.InvalidSubnetException
- An invalid subnet identifier was specified.ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
The CreateReplicationGroup action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.
When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.
This action is valid only for Redis.
createReplicationGroupRequest
- Represents the input of a CreateReplicationGroup action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.ReplicationGroupAlreadyExistsException
- The specified replication group already exists.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified
Availability Zone.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an
existing cache subnet group.ClusterQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache clusters per customer.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes in a single cache cluster.NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes per customer.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.TagQuotaPerResourceExceededException
- The request cannot be processed because it would cause the
resource to have more than the allowed number of tags. The
maximum number of tags permitted on a resource is 10.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest)
The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
createSnapshotRequest
- Represents the input of a CreateSnapshot action.SnapshotAlreadyExistsException
- You already have a snapshot with the given name.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.SnapshotQuotaExceededException
- The request cannot be processed because it would exceed the
maximum number of snapshots.SnapshotFeatureNotSupportedException
- You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidParameterValueException
- The value for a parameter is invalid.CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
The DeleteCacheCluster action deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.
This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.
deleteCacheClusterRequest
- Represents the input of a DeleteCacheCluster action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.SnapshotAlreadyExistsException
- You already have a snapshot with the given name.SnapshotFeatureNotSupportedException
- You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException
- The request cannot be processed because it would exceed the
maximum number of snapshots.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
The DeleteCacheParameterGroup action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
deleteCacheParameterGroupRequest
- Represents the input of a DeleteCacheParameterGroup action.InvalidCacheParameterGroupStateException
- The current state of the cache parameter group does not allow the
requested action to occur.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
The DeleteCacheSecurityGroup action deletes a cache security group.
You cannot delete a cache security group if it is associated with any cache clusters.
deleteCacheSecurityGroupRequest
- Represents the input of a DeleteCacheSecurityGroup action.InvalidCacheSecurityGroupStateException
- The current state of the cache security group does not allow
deletion.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
The DeleteCacheSubnetGroup action deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any cache clusters.
deleteCacheSubnetGroupRequest
- Represents the input of a DeleteCacheSubnetGroup action.CacheSubnetGroupInUseException
- The requested cache subnet group is currently in use.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an
existing cache subnet group.ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
The DeleteReplicationGroup action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.
When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.
deleteReplicationGroupRequest
- Represents the input of a DeleteReplicationGroup action.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.SnapshotAlreadyExistsException
- You already have a snapshot with the given name.SnapshotFeatureNotSupportedException
- You attempted one of the following actions:
Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.
Creating a snapshot of a cache cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException
- The request cannot be processed because it would exceed the
maximum number of snapshots.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
The DeleteSnapshot action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action.
deleteSnapshotRequest
- Represents the input of a DeleteSnapshot action.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.InvalidSnapshotStateException
- The current state of the snapshot does not allow the requested
action to occur.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
describeCacheClustersRequest
- Represents the input of a DescribeCacheClusters action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeCacheClustersResult describeCacheClusters()
DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
describeCacheEngineVersionsRequest
- Represents the input of a DescribeCacheEngineVersions
action.DescribeCacheEngineVersionsResult describeCacheEngineVersions()
DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
describeCacheParameterGroupsRequest
- Represents the input of a DescribeCacheParameterGroups
action.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeCacheParameterGroupsResult describeCacheParameterGroups()
DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersRequest
- Represents the input of a DescribeCacheParameters action.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
describeCacheSecurityGroupsRequest
- Represents the input of a DescribeCacheSecurityGroups
action.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
describeCacheSubnetGroupsRequest
- Represents the input of a DescribeCacheSubnetGroups action.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an
existing cache subnet group.DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersRequest
- Represents the input of a DescribeEngineDefaultParameters
action.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
describeEventsRequest
- Represents the input of a DescribeEvents action.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeEventsResult describeEvents()
describeEvents(DescribeEventsRequest)
DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
describeReplicationGroupsRequest
- Represents the input of a DescribeReplicationGroups action.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeReplicationGroupsResult describeReplicationGroups()
DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesRequest
- Represents the input of a DescribeReservedCacheNodes
action.ReservedCacheNodeNotFoundException
- The requested reserved cache node was not found.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeReservedCacheNodesResult describeReservedCacheNodes()
DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest
- Represents the input of a
DescribeReservedCacheNodesOfferings action.ReservedCacheNodesOfferingNotFoundException
- The requested cache node offering does not exist.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
The DescribeSnapshots action returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
describeSnapshotsRequest
- Represents the input of a DescribeSnapshotsMessage action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.DescribeSnapshotsResult describeSnapshots()
ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
The ListAllowedNodeTypeModifications
action lists all
available node types that you can scale your Redis cluster's or
replication group's current node type up to.
When you use the ModifyCacheCluster
or
ModifyReplicationGroup
APIs to scale up your cluster or
replication group, the value of the CacheNodeType parameter must
be one of the node types returned by this action.
listAllowedNodeTypeModificationsRequest
- The input parameters for the
ListAllowedNodeTypeModifications action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidParameterValueException
- The value for a parameter is invalid.ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
The ListTagsForResource action lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. Cost allocation tags can be used to categorize and track your AWS costs.
You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.
listTagsForResourceRequest
- The input parameters for the ListTagsForResource action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an
existing resource.CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
The ModifyCacheCluster action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
modifyCacheClusterRequest
- Represents the input of a ModifyCacheCluster action.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.InvalidCacheSecurityGroupStateException
- The current state of the cache security group does not allow
deletion.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified
Availability Zone.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes in a single cache cluster.NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
The ModifyCacheParameterGroup action modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
modifyCacheParameterGroupRequest
- Represents the input of a ModifyCacheParameterGroup action.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidCacheParameterGroupStateException
- The current state of the cache parameter group does not allow the
requested action to occur.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
modifyCacheSubnetGroupRequest
- Represents the input of a ModifyCacheSubnetGroup action.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an
existing cache subnet group.CacheSubnetQuotaExceededException
- The request cannot be processed because it would exceed the
allowed number of subnets in a cache subnet group.SubnetInUseException
- The requested subnet is being used by another cache subnet group.InvalidSubnetException
- An invalid subnet identifier was specified.ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
The ModifyReplicationGroup action modifies the settings for a replication group.
modifyReplicationGroupRequest
- Represents the input of a ModifyReplicationGroups action.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.InvalidCacheSecurityGroupStateException
- The current state of the cache security group does not allow
deletion.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified
Availability Zone.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes in a single cache cluster.NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the
allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOfferingRequest
- Represents the input of a
PurchaseReservedCacheNodesOffering action.ReservedCacheNodesOfferingNotFoundException
- The requested cache node offering does not exist.ReservedCacheNodeAlreadyExistsException
- You already have a reservation with the given identifier.ReservedCacheNodeQuotaExceededException
- The request cannot be processed because it would exceed the
user's cache node quota.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cache cluster event is created.
rebootCacheClusterRequest
- Represents the input of a RebootCacheCluster action.InvalidCacheClusterStateException
- The requested cache cluster is not in the available state.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
The RemoveTagsFromResource action removes the tags identified by
the TagKeys
list from the named resource.
removeTagsFromResourceRequest
- Represents the input of a RemoveTagsFromResource action.CacheClusterNotFoundException
- The requested cache cluster ID does not refer to an existing
cache cluster.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing
snapshot.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an
existing resource.TagNotFoundException
- The requested tag was not found on this resource.ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
The ResetCacheParameterGroup action modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
resetCacheParameterGroupRequest
- Represents the input of a ResetCacheParameterGroup action.InvalidCacheParameterGroupStateException
- The current state of the cache parameter group does not allow the
requested action to occur.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an
existing cache parameter group.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngressRequest
- Represents the input of a RevokeCacheSecurityGroupIngress
action.CacheSecurityGroupNotFoundException
- The requested cache security group name does not refer to an
existing cache security group.AuthorizationNotFoundException
- The specified Amazon EC2 security group is not authorized for the
specified cache security group.InvalidCacheSecurityGroupStateException
- The current state of the cache security group does not allow
deletion.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2016. All rights reserved.