@ThreadSafe public class AmazonElastiCacheClient extends AmazonWebServiceClient implements 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 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 and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonElastiCacheClient()
Constructs a new client to invoke service methods on Amazon ElastiCache.
|
AmazonElastiCacheClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account
credentials.
|
AmazonElastiCacheClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account
credentials and client configuration options.
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account
credentials provider.
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account
credentials provider and client configuration options.
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account
credentials provider, client configuration options, and request metric collector.
|
AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ElastiCache.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds up to 10 cost allocation tags to the named resource.
|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
Allows network ingress to a cache security group.
|
Snapshot |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
Makes a copy of an existing snapshot.
|
CacheCluster |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
Creates a cache cluster.
|
CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
Creates a new cache parameter group.
|
CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
Creates a new cache security group.
|
CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
Creates a new cache subnet group.
|
ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
|
Snapshot |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cache cluster or replication group at a specific moment in time.
|
CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
Deletes a previously provisioned cache cluster.
|
DeleteCacheParameterGroupResult |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group.
|
DeleteCacheSecurityGroupResult |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
Deletes a cache security group.
|
DeleteCacheSubnetGroupResult |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
|
ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
Deletes an existing replication group.
|
Snapshot |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes an existing snapshot.
|
DescribeCacheClustersResult |
describeCacheClusters()
Simplified method form for invoking the DescribeCacheClusters operation.
|
DescribeCacheClustersResult |
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.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions()
Simplified method form for invoking the DescribeCacheEngineVersions operation.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
Simplified method form for invoking the DescribeCacheParameterGroups operation.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
DescribeCacheParametersResult |
describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups()
Simplified method form for invoking the DescribeCacheSecurityGroups operation.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
Simplified method form for invoking the DescribeCacheSubnetGroups operation.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to cache clusters, cache security groups, and cache parameter groups.
|
DescribeReplicationGroupsResult |
describeReplicationGroups()
Simplified method form for invoking the DescribeReplicationGroups operation.
|
DescribeReplicationGroupsResult |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
Simplified method form for invoking the DescribeReservedCacheNodes operation.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings()
Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cache cluster or replication group snapshots.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications()
Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
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)
Lists all cost allocation tags currently on the named resource.
|
CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
Modifies the settings for a cache cluster.
|
ModifyCacheParameterGroupResult |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group.
|
CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
|
ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
Modifies the settings for a replication group.
|
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
|
CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
Reboots some, or all, of the cache nodes within a provisioned cache cluster.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the
TagKeys list from the named resource. |
ResetCacheParameterGroupResult |
resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group to the engine or system default value.
|
CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group.
|
AmazonElastiCacheWaiters |
waiters() |
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonElastiCacheClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon ElastiCache (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonElastiCacheClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.public AmazonElastiCacheClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon ElastiCache (ex: proxy
settings, retry counts, etc.).public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon ElastiCache (ex: proxy
settings, retry counts, etc.).public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon ElastiCache (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
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. 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.
addTagsToResource
in interface AmazonElastiCache
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 10.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an existing resource.public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
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.
authorizeCacheSecurityGroupIngress
in interface AmazonElastiCache
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.public Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest)
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.
copySnapshot
in interface AmazonElastiCache
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.public CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
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.
createCacheCluster
in interface AmazonElastiCache
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 10.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
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.
createCacheParameterGroup
in interface AmazonElastiCache
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.public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
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.
createCacheSecurityGroup
in interface AmazonElastiCache
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.public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroup
in interface AmazonElastiCache
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.public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
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.
This operation is valid for Redis only.
createReplicationGroup
in interface AmazonElastiCache
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 10.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.public Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cache cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
createSnapshot
in interface AmazonElastiCache
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.public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
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.
deleteCacheCluster
in interface AmazonElastiCache
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.public DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
deleteCacheParameterGroup
in interface AmazonElastiCache
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.public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any cache clusters.
deleteCacheSecurityGroup
in interface AmazonElastiCache
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.public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any cache clusters.
deleteCacheSubnetGroup
in interface AmazonElastiCache
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.public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
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.
deleteReplicationGroup
in interface AmazonElastiCache
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.public Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
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.
deleteSnapshot
in interface AmazonElastiCache
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.public DescribeCacheClustersResult 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.
By default, abbreviated information about the cache clusters are 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 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.
describeCacheClusters
in interface AmazonElastiCache
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.public DescribeCacheClustersResult describeCacheClusters()
AmazonElastiCache
describeCacheClusters
in interface AmazonElastiCache
AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
describeCacheEngineVersions
in interface AmazonElastiCache
describeCacheEngineVersionsRequest
- Represents the input of a DescribeCacheEngineVersions
operation.public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
AmazonElastiCache
describeCacheEngineVersions
in interface AmazonElastiCache
AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
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.
describeCacheParameterGroups
in interface AmazonElastiCache
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.public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
AmazonElastiCache
describeCacheParameterGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParameters
in interface AmazonElastiCache
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.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
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.
describeCacheSecurityGroups
in interface AmazonElastiCache
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.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
AmazonElastiCache
describeCacheSecurityGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
describeCacheSubnetGroups
in interface AmazonElastiCache
describeCacheSubnetGroupsRequest
- Represents the input of a DescribeCacheSubnetGroups
operation.CacheSubnetGroupNotFoundException
- The requested cache subnet group name does not refer to an existing cache subnet group.public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
AmazonElastiCache
describeCacheSubnetGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParameters
in interface AmazonElastiCache
describeEngineDefaultParametersRequest
- Represents the input of a DescribeEngineDefaultParameters
operation.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
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.
describeEvents
in interface AmazonElastiCache
describeEventsRequest
- Represents the input of a DescribeEvents
operation.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeEventsResult describeEvents()
AmazonElastiCache
describeEvents
in interface AmazonElastiCache
AmazonElastiCache.describeEvents(DescribeEventsRequest)
public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
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.
describeReplicationGroups
in interface AmazonElastiCache
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.public DescribeReplicationGroupsResult describeReplicationGroups()
AmazonElastiCache
describeReplicationGroups
in interface AmazonElastiCache
AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodes
in interface AmazonElastiCache
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.public DescribeReservedCacheNodesResult describeReservedCacheNodes()
AmazonElastiCache
describeReservedCacheNodes
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
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.public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
AmazonElastiCache
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
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.
describeSnapshots
in interface AmazonElastiCache
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.public DescribeSnapshotsResult describeSnapshots()
AmazonElastiCache
describeSnapshots
in interface AmazonElastiCache
AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)
public ListAllowedNodeTypeModificationsResult 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.
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.
listAllowedNodeTypeModifications
in interface AmazonElastiCache
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.public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
AmazonElastiCache
listAllowedNodeTypeModifications
in interface AmazonElastiCache
AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.
listTagsForResource
in interface AmazonElastiCache
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.public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
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.
modifyCacheCluster
in interface AmazonElastiCache
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.public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
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.
modifyCacheParameterGroup
in interface AmazonElastiCache
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.public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
modifyCacheSubnetGroup
in interface AmazonElastiCache
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.public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
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.
modifyReplicationGroup
in interface AmazonElastiCache
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.public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOffering
in interface AmazonElastiCache
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.public CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
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.
rebootCacheCluster
in interface AmazonElastiCache
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.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the TagKeys
list from the named resource.
removeTagsFromResource
in interface AmazonElastiCache
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.public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
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.
resetCacheParameterGroup
in interface AmazonElastiCache
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.public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngress
in interface AmazonElastiCache
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonElastiCache
request
- The originally executed requestpublic AmazonElastiCacheWaiters waiters()
waiters
in interface AmazonElastiCache
Copyright © 2016. All rights reserved.