AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface ElastiCacheClient extends AutoCloseable
builder() method.
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 get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in 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 | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds up to 50 cost allocation tags to the named resource.
|
default CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) |
Allows network ingress to a cache security group.
|
static ElastiCacheClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ElastiCacheClient. |
default Snapshot |
copySnapshot(CopySnapshotRequest copySnapshotRequest) |
Makes a copy of an existing snapshot.
|
static ElastiCacheClient |
create() |
Create a
ElastiCacheClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CacheCluster |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) |
Creates a cache cluster.
|
default CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) |
Creates a new Amazon ElastiCache cache parameter group.
|
default CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) |
Creates a new cache security group.
|
default CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) |
Creates a new cache subnet group.
|
default ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) |
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
|
default Snapshot |
createSnapshot(CreateSnapshotRequest createSnapshotRequest) |
Creates a copy of an entire cache cluster or replication group at a specific moment in time.
|
default CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) |
Deletes a previously provisioned cache cluster.
|
default DeleteCacheParameterGroupResponse |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) |
Deletes the specified cache parameter group.
|
default DeleteCacheSecurityGroupResponse |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) |
Deletes a cache security group.
|
default DeleteCacheSubnetGroupResponse |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) |
Deletes a cache subnet group.
|
default ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest) |
Deletes an existing replication group.
|
default Snapshot |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) |
Deletes an existing snapshot.
|
default DescribeCacheClustersResponse |
describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) |
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.
|
default DescribeCacheEngineVersionsResponse |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) |
Returns a list of the available cache engines and their versions.
|
default DescribeCacheParameterGroupsResponse |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) |
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParametersResponse |
describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) |
Returns the detailed parameter list for a particular cache parameter group.
|
default DescribeCacheSecurityGroupsResponse |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) |
Returns a list of cache security group descriptions.
|
default DescribeCacheSubnetGroupsResponse |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) |
Returns a list of cache subnet group descriptions.
|
default EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) |
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest) |
Returns events related to cache clusters, cache security groups, and cache parameter groups.
|
default DescribeReplicationGroupsResponse |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) |
Returns information about a particular replication group.
|
default DescribeReservedCacheNodesResponse |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) |
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesOfferingsResponse |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) |
Lists available reserved cache node offerings.
|
default DescribeSnapshotsResponse |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) |
Returns information about cache cluster or replication group snapshots.
|
default ListAllowedNodeTypeModificationsResponse |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) |
Lists all available node types that you can scale your Redis cluster's or replication group's current node type
up to.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Lists all cost allocation tags currently on the named resource.
|
default CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) |
Modifies the settings for a cache cluster.
|
default ModifyCacheParameterGroupResponse |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) |
Modifies the parameters of a cache parameter group.
|
default CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) |
Modifies an existing cache subnet group.
|
default ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) |
Modifies the settings for a replication group.
|
default ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) |
Allows you to purchase a reserved cache node offering.
|
default CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) |
Reboots some, or all, of the cache nodes within a provisioned cache cluster.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes the tags identified by the
TagKeys list from the named resource. |
default ResetCacheParameterGroupResponse |
resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) |
Modifies the parameters of a cache parameter group to the engine or system default value.
|
default CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) |
Revokes ingress from a cache security group.
|
static ServiceMetadata |
serviceMetadata() |
|
default ReplicationGroup |
testFailover(TestFailoverRequest testFailoverRequest) |
Represents the input of a
TestFailover operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
ElastiCacheClientWaiters |
waiters() |
closestatic final String SERVICE_NAME
static ElastiCacheClient create()
ElastiCacheClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElastiCacheClientBuilder builder()
ElastiCacheClient.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, TagQuotaPerResourceExceededException, InvalidARNException, SdkBaseException, SdkClientException, ElastiCacheException
Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags 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 operation.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 50.InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException, AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the CopySnapshot operation 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 operation. For more information about using IAM to control the
use of ElastiCache operations, see Exporting
Snapshots and Authentication
& Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
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.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you
could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
copySnapshotRequest - Represents the input of a CopySnapshotMessage operation.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 operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVPCNetworkStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
createCacheClusterRequest - Represents the input of a CreateCacheCluster operation.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 50.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cache cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.
createCacheParameterGroupRequest - Represents the input of a CreateCacheParameterGroup operation.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 operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 (Amazon 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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, InvalidSubnetException, SdkBaseException, SdkClientException, ElastiCacheException
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroupRequest - Represents the input of a CreateCacheSubnetGroup operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVPCNetworkStateException, TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
A Redis (cluster mode disabled) 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 asynchronously propagated to the replicas.
A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.
This operation is valid for Redis only.
createReplicationGroupRequest - Represents the input of a CreateReplicationGroup operation.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 50.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum of 15 node groups (shards) in a
single replication group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, InvalidParameterCombinationException, InvalidParameterValueException, SdkBaseException, SdkClientException, ElastiCacheException
Creates a copy of an entire cache cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
createSnapshotRequest - Represents the input of a CreateSnapshot operation.SnapshotAlreadyExistsException - You already have a snapshot with the given name.CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidCacheClusterStateException - The requested cache cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group 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 operations:
Creating a snapshot of a Redis cache cluster running on a cache.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation,
Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.
This operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
deleteCacheClusterRequest - Represents the input of a DeleteCacheCluster operation.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 operations:
Creating a snapshot of a Redis cache cluster running on a cache.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCacheParameterGroupResponse deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Deletes an existing replication group. By default, this operation deletes the entire replication group, including
the primary/primaries and all of the read replicas. If the replication group has only one primary, you can
optionally delete only the read replicas, while retaining the primary by setting
RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This operation is valid for Redis only.
deleteReplicationGroupRequest - Represents the input of a DeleteReplicationGroup operation.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 operations:
Creating a snapshot of a Redis cache cluster running on a cache.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Redis only.
deleteSnapshotRequest - Represents the input of a DeleteSnapshot operation.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCacheClustersResponse describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 is returned. You can use the optional ShowCacheNodeInfo 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 is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not 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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCacheEngineVersionsResponse describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws SdkBaseException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.SdkBaseExceptionSdkClientExceptionElastiCacheExceptiondefault DescribeCacheParameterGroupsResponse describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCacheParametersResponse describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, SdkBaseException, SdkClientException, ElastiCacheException
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReplicationGroupsResponse describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Redis only.
describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReservedCacheNodesResponse describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Returns information about cache cluster or replication group 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.
This operation is valid for Redis only.
describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException, InvalidParameterValueException, SdkBaseException, SdkClientException, ElastiCacheException
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 operations to scale up
your cluster or replication group, the value of the CacheNodeType parameter must be one of the node
types returned by this operation.
listAllowedNodeTypeModificationsRequest - The input parameters for the ListAllowedNodeTypeModifications operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidARNException, SdkBaseException, SdkClientException, ElastiCacheException
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. You can use cost allocation tags to categorize
and track your AWS costs.
You can have a maximum of 50 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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVPCNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
modifyCacheClusterRequest - Represents the input of a ModifyCacheCluster operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyCacheParameterGroupResponse modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.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 operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, SdkBaseException, SdkClientException, ElastiCacheException
Modifies an existing cache subnet group.
modifyCacheSubnetGroupRequest - Represents the input of a ModifyCacheSubnetGroup operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVPCNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Modifies the settings for a replication group.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
This operation is valid for Redis only.
modifyReplicationGroupRequest - Represents the input of a ModifyReplicationGroups operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOfferingRequest - Represents the input of a PurchaseReservedCacheNodesOffering operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) throws InvalidCacheClusterStateException, CacheClusterNotFoundException, SdkBaseException, SdkClientException, ElastiCacheException
Reboots some, or all, of the cache nodes within a provisioned cache cluster. This operation applies any modified cache parameter groups to the cache cluster. The reboot operation 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 operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidARNException, TagNotFoundException, SdkBaseException, SdkClientException, ElastiCacheException
Removes the tags identified by the TagKeys list from the named resource.
removeTagsFromResourceRequest - Represents the input of a RemoveTagsFromResource operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ResetCacheParameterGroupResponse resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
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 operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation 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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngressRequest - Represents the input of a RevokeCacheSecurityGroupIngress operation.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.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReplicationGroup testFailover(TestFailoverRequest testFailoverRequest) throws APICallRateForCustomerExceededException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException, TestFailoverNotAvailableException, InvalidParameterValueException, InvalidParameterCombinationException, SdkBaseException, SdkClientException, ElastiCacheException
Represents the input of a TestFailover operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console).
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
testFailoverRequest - APICallRateForCustomerExceededException - The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException - The requested cache cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group is not in the available state.NodeGroupNotFoundException - The node group specified by the NodeGroupId parameter could not be found. Please verify that
the node group exists and that you spelled the NodeGroupId value correctly.ReplicationGroupNotFoundException - The specified replication group does not exist.TestFailoverNotAvailableExceptionInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)ElastiCacheException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
ElastiCacheClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.