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 | 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.
|
void |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
The DeleteCacheParameterGroup action deletes the specified
cache parameter group.
|
void |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
The DeleteCacheSecurityGroup action deletes a cache security
group.
|
void |
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()
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.
|
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()
The DescribeCacheEngineVersions action returns a list of the
available cache engines and their versions.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
The DescribeCacheEngineVersions action returns a list of the
available cache engines and their versions.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
The DescribeCacheParameterGroups action returns a list of
cache parameter group descriptions.
|
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()
The DescribeCacheSecurityGroups action returns a list of cache
security group descriptions.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
The DescribeCacheSecurityGroups action returns a list of cache
security group descriptions.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
The DescribeCacheSubnetGroups action returns a list of cache
subnet group descriptions.
|
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()
The DescribeEvents action returns events related to cache
clusters, cache security groups, and cache parameter groups.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
The DescribeEvents action returns events related to cache
clusters, cache security groups, and cache parameter groups.
|
DescribeReplicationGroupsResult |
describeReplicationGroups()
The DescribeReplicationGroups action returns information about
a particular replication group.
|
DescribeReplicationGroupsResult |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
The DescribeReplicationGroups action returns information about
a particular replication group.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
The DescribeReservedCacheNodes action returns information
about reserved cache nodes for this account, or about a specified
reserved cache node.
|
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()
The DescribeReservedCacheNodesOfferings action lists available
reserved cache node offerings.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
The DescribeReservedCacheNodesOfferings action lists available
reserved cache node offerings.
|
DescribeSnapshotsResult |
describeSnapshots()
The DescribeSnapshots action returns information about cache
cluster snapshots.
|
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()
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. |
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 ("https://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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "elasticache.us-east-1.amazonaws.com/") or a full
URL, including the protocol (ex: "https://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: "https://elasticache.us-east-1.amazonaws.com/") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AmazonServiceException, AmazonClientException
The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersRequest - Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
service method on AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DeleteCacheCluster service method on
AmazonElastiCache.InvalidParameterValueExceptionSnapshotFeatureNotSupportedExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionInvalidCacheClusterStateExceptionSnapshotAlreadyExistsExceptionSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DeleteReplicationGroup service method on
AmazonElastiCache.InvalidReplicationGroupStateExceptionInvalidParameterValueExceptionSnapshotFeatureNotSupportedExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionSnapshotAlreadyExistsExceptionSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws AmazonServiceException, AmazonClientException
The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesRequest - Container for the necessary
parameters to execute the DescribeReservedCacheNodes service method on
AmazonElastiCache.ReservedCacheNodeNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary parameters to
execute the DeleteSnapshot service method on AmazonElastiCache.InvalidSnapshotStateExceptionInvalidParameterValueExceptionSnapshotNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.void deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
The DeleteCacheSubnetGroup action deletes a cache subnet group.
NOTE:You cannot delete a cache subnet group if it is associated with any cache clusters.
deleteCacheSubnetGroupRequest - Container for the necessary
parameters to execute the DeleteCacheSubnetGroup service method on
AmazonElastiCache.CacheSubnetGroupNotFoundExceptionCacheSubnetGroupInUseExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the CreateCacheSubnetGroup service method on
AmazonElastiCache.CacheSubnetGroupAlreadyExistsExceptionCacheSubnetGroupQuotaExceededExceptionCacheSubnetQuotaExceededExceptionInvalidSubnetExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws AmazonServiceException, AmazonClientException
The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersRequest - Container for the necessary
parameters to execute the DescribeCacheParameters service method on
AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the ListTagsForResource service method on
AmazonElastiCache.SnapshotNotFoundExceptionCacheClusterNotFoundExceptionInvalidARNExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.void deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
The DeleteCacheSecurityGroup action deletes a cache security group.
NOTE:You cannot delete a cache security group if it is associated with any cache clusters.
deleteCacheSecurityGroupRequest - Container for the necessary
parameters to execute the DeleteCacheSecurityGroup service method on
AmazonElastiCache.InvalidParameterValueExceptionInvalidCacheSecurityGroupStateExceptionInvalidParameterCombinationExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the
necessary parameters to execute the ListAllowedNodeTypeModifications
service method on AmazonElastiCache.InvalidParameterValueExceptionCacheClusterNotFoundExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws AmazonServiceException, AmazonClientException
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 .
addTagsToResourceRequest - Container for the necessary parameters
to execute the AddTagsToResource service method on AmazonElastiCache.SnapshotNotFoundExceptionTagQuotaPerResourceExceededExceptionCacheClusterNotFoundExceptionInvalidARNExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary parameters
to execute the DescribeSnapshots service method on AmazonElastiCache.InvalidParameterValueExceptionSnapshotNotFoundExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest) throws AmazonServiceException, AmazonClientException
The CopySnapshot action makes a copy of an existing snapshot.
copySnapshotRequest - Container for the necessary parameters to
execute the CopySnapshot service method on AmazonElastiCache.InvalidSnapshotStateExceptionInvalidParameterValueExceptionSnapshotNotFoundExceptionInvalidParameterCombinationExceptionSnapshotAlreadyExistsExceptionSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DescribeCacheSecurityGroups service method
on AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the
necessary parameters to execute the RevokeCacheSecurityGroupIngress
service method on AmazonElastiCache.InvalidParameterValueExceptionInvalidCacheSecurityGroupStateExceptionAuthorizationNotFoundExceptionInvalidParameterCombinationExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) throws AmazonServiceException, AmazonClientException
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.
Note: This action is valid only for Redis.
createReplicationGroupRequest - Container for the necessary
parameters to execute the CreateReplicationGroup service method on
AmazonElastiCache.ReplicationGroupAlreadyExistsExceptionNodeQuotaForCustomerExceededExceptionNodeQuotaForClusterExceededExceptionCacheSubnetGroupNotFoundExceptionInvalidParameterValueExceptionClusterQuotaForCustomerExceededExceptionInvalidVPCNetworkStateExceptionTagQuotaPerResourceExceededExceptionInsufficientCacheClusterCapacityExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionInvalidCacheClusterStateExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws AmazonServiceException, AmazonClientException
The RemoveTagsFromResource action removes the tags identified
by the TagKeys list from the named resource.
removeTagsFromResourceRequest - Container for the necessary
parameters to execute the RemoveTagsFromResource service method on
AmazonElastiCache.TagNotFoundExceptionSnapshotNotFoundExceptionCacheClusterNotFoundExceptionInvalidARNExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the CreateCacheCluster service method on
AmazonElastiCache.NodeQuotaForCustomerExceededExceptionClusterQuotaForCustomerExceededExceptionCacheClusterAlreadyExistsExceptionTagQuotaPerResourceExceededExceptionInsufficientCacheClusterCapacityExceptionInvalidParameterCombinationExceptionReplicationGroupNotFoundExceptionCacheParameterGroupNotFoundExceptionCacheSecurityGroupNotFoundExceptionNodeQuotaForClusterExceededExceptionCacheSubnetGroupNotFoundExceptionInvalidReplicationGroupStateExceptionInvalidParameterValueExceptionInvalidVPCNetworkStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AmazonServiceException, AmazonClientException
The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
describeCacheEngineVersionsRequest - Container for the necessary
parameters to execute the DescribeCacheEngineVersions service method
on AmazonElastiCache.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
modifyCacheSubnetGroupRequest - Container for the necessary
parameters to execute the ModifyCacheSubnetGroup service method on
AmazonElastiCache.CacheSubnetGroupNotFoundExceptionCacheSubnetQuotaExceededExceptionInvalidSubnetExceptionSubnetInUseExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.void deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DeleteCacheParameterGroup service method on
AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionInvalidCacheParameterGroupStateExceptionCacheParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws AmazonServiceException, AmazonClientException
The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
createSnapshotRequest - Container for the necessary parameters to
execute the CreateSnapshot service method on AmazonElastiCache.InvalidParameterValueExceptionSnapshotFeatureNotSupportedExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionSnapshotAlreadyExistsExceptionInvalidCacheClusterStateExceptionSnapshotQuotaExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary parameters to
execute the DescribeEvents service method on AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) throws AmazonServiceException, AmazonClientException
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.
NOTE:You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
authorizeCacheSecurityGroupIngressRequest - Container for the
necessary parameters to execute the AuthorizeCacheSecurityGroupIngress
service method on AmazonElastiCache.InvalidParameterValueExceptionAuthorizationAlreadyExistsExceptionInvalidCacheSecurityGroupStateExceptionInvalidParameterCombinationExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws AmazonServiceException, AmazonClientException
The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOfferingRequest - Container for the
necessary parameters to execute the PurchaseReservedCacheNodesOffering
service method on AmazonElastiCache.InvalidParameterValueExceptionReservedCacheNodeQuotaExceededExceptionReservedCacheNodeAlreadyExistsExceptionReservedCacheNodesOfferingNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) throws AmazonServiceException, AmazonClientException
The ModifyReplicationGroup action modifies the settings for a replication group.
modifyReplicationGroupRequest - Container for the necessary
parameters to execute the ModifyReplicationGroup service method on
AmazonElastiCache.NodeQuotaForCustomerExceededExceptionNodeQuotaForClusterExceededExceptionInvalidParameterValueExceptionInvalidReplicationGroupStateExceptionInvalidCacheSecurityGroupStateExceptionInvalidVPCNetworkStateExceptionInsufficientCacheClusterCapacityExceptionCacheClusterNotFoundExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionInvalidCacheClusterStateExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws AmazonServiceException, AmazonClientException
The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
describeReplicationGroupsRequest - Container for the necessary
parameters to execute the DescribeReplicationGroups service method on
AmazonElastiCache.InvalidParameterValueExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the ModifyCacheParameterGroup service method on
AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionInvalidCacheParameterGroupStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws AmazonServiceException, AmazonClientException
The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest - Container for the
necessary parameters to execute the
DescribeReservedCacheNodesOfferings service method on
AmazonElastiCache.InvalidParameterValueExceptionReservedCacheNodesOfferingNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the ModifyCacheCluster service method on
AmazonElastiCache.NodeQuotaForCustomerExceededExceptionNodeQuotaForClusterExceededExceptionInvalidParameterValueExceptionInvalidCacheSecurityGroupStateExceptionInvalidVPCNetworkStateExceptionInsufficientCacheClusterCapacityExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionInvalidCacheClusterStateExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the ResetCacheParameterGroup service method on
AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionInvalidCacheParameterGroupStateExceptionCacheParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DescribeCacheClusters service method on
AmazonElastiCache.InvalidParameterValueExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the CreateCacheSecurityGroup service method on
AmazonElastiCache.CacheSecurityGroupAlreadyExistsExceptionInvalidParameterValueExceptionCacheSecurityGroupQuotaExceededExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DescribeCacheSubnetGroups service method on
AmazonElastiCache.CacheSubnetGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the DescribeCacheParameterGroups service method
on AmazonElastiCache.InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the RebootCacheCluster service method on
AmazonElastiCache.CacheClusterNotFoundExceptionInvalidCacheClusterStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws AmazonServiceException, AmazonClientException
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 - Container for the necessary
parameters to execute the CreateCacheParameterGroup service method on
AmazonElastiCache.InvalidParameterValueExceptionCacheParameterGroupQuotaExceededExceptionCacheParameterGroupAlreadyExistsExceptionInvalidParameterCombinationExceptionInvalidCacheParameterGroupStateExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReservedCacheNodesResult describeReservedCacheNodes() throws AmazonServiceException, AmazonClientException
The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
ReservedCacheNodeNotFoundExceptionInvalidParameterValueExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionCacheClusterNotFoundExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeSnapshotsResult describeSnapshots() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionSnapshotNotFoundExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheSecurityGroupsResult describeCacheSecurityGroups() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheSecurityGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheEngineVersionsResult describeCacheEngineVersions() throws AmazonServiceException, AmazonClientException
The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReplicationGroupsResult describeReplicationGroups() throws AmazonServiceException, AmazonClientException
The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
InvalidParameterValueExceptionReplicationGroupNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings() throws AmazonServiceException, AmazonClientException
The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
InvalidParameterValueExceptionReservedCacheNodesOfferingNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheClustersResult describeCacheClusters() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionCacheClusterNotFoundExceptionInvalidParameterCombinationExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheSubnetGroupsResult describeCacheSubnetGroups() throws AmazonServiceException, AmazonClientException
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.
CacheSubnetGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.DescribeCacheParameterGroupsResult describeCacheParameterGroups() throws AmazonServiceException, AmazonClientException
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.
InvalidParameterValueExceptionInvalidParameterCombinationExceptionCacheParameterGroupNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonElastiCache indicating
either a problem with the data in the request, or a server side issue.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.