@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonElastiCacheClient()
Deprecated.
|
AmazonElastiCacheClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonElastiCacheClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonElastiCacheClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
A tag is a key-value pair where the key and value are case-sensitive.
|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
Allows network ingress to a cache security group.
|
BatchApplyUpdateActionResult |
batchApplyUpdateAction(BatchApplyUpdateActionRequest request)
Apply the service update.
|
BatchStopUpdateActionResult |
batchStopUpdateAction(BatchStopUpdateActionRequest request)
Stop the service update.
|
static AmazonElastiCacheClientBuilder |
builder() |
ReplicationGroup |
completeMigration(CompleteMigrationRequest request)
Complete the migration of data.
|
CopyServerlessCacheSnapshotResult |
copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest request)
Creates a copy of an existing serverless cache’s snapshot.
|
Snapshot |
copySnapshot(CopySnapshotRequest request)
Makes a copy of an existing snapshot.
|
CacheCluster |
createCacheCluster(CreateCacheClusterRequest request)
Creates a cluster.
|
CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest request)
Creates a new Amazon ElastiCache cache parameter group.
|
CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
Creates a new cache security group.
|
CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
Creates a new cache subnet group.
|
GlobalReplicationGroup |
createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)
Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication.
|
ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest request)
Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.
|
CreateServerlessCacheResult |
createServerlessCache(CreateServerlessCacheRequest request)
Creates a serverless cache.
|
CreateServerlessCacheSnapshotResult |
createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest request)
This API creates a copy of an entire ServerlessCache at a specific moment in time.
|
Snapshot |
createSnapshot(CreateSnapshotRequest request)
Creates a copy of an entire cluster or replication group at a specific moment in time.
|
CreateUserResult |
createUser(CreateUserRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user.
|
CreateUserGroupResult |
createUserGroup(CreateUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group.
|
GlobalReplicationGroup |
decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
Decreases the number of node groups in a Global datastore
|
ReplicationGroup |
decreaseReplicaCount(DecreaseReplicaCountRequest request)
Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the
number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication
group.
|
CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest request)
Deletes a previously provisioned cluster.
|
DeleteCacheParameterGroupResult |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
Deletes the specified cache parameter group.
|
DeleteCacheSecurityGroupResult |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
Deletes a cache security group.
|
DeleteCacheSubnetGroupResult |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
Deletes a cache subnet group.
|
GlobalReplicationGroup |
deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)
Deleting a Global datastore is a two-step process:
|
ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest request)
Deletes an existing replication group.
|
DeleteServerlessCacheResult |
deleteServerlessCache(DeleteServerlessCacheRequest request)
Deletes a specified existing serverless cache.
|
DeleteServerlessCacheSnapshotResult |
deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest request)
Deletes an existing serverless cache snapshot.
|
Snapshot |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes an existing snapshot.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user.
|
DeleteUserGroupResult |
deleteUserGroup(DeleteUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user group.
|
DescribeCacheClustersResult |
describeCacheClusters()
Simplified method form for invoking the DescribeCacheClusters operation.
|
DescribeCacheClustersResult |
describeCacheClusters(DescribeCacheClustersRequest request)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions()
Simplified method form for invoking the DescribeCacheEngineVersions operation.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
Returns a list of the available cache engines and their versions.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
Simplified method form for invoking the DescribeCacheParameterGroups operation.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
Returns a list of cache parameter group descriptions.
|
DescribeCacheParametersResult |
describeCacheParameters(DescribeCacheParametersRequest request)
Returns the detailed parameter list for a particular cache parameter group.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups()
Simplified method form for invoking the DescribeCacheSecurityGroups operation.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
Returns a list of cache security group descriptions.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
Simplified method form for invoking the DescribeCacheSubnetGroups operation.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
Returns a list of cache subnet group descriptions.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
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 request)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
DescribeGlobalReplicationGroupsResult |
describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)
Returns information about a particular global replication group.
|
DescribeReplicationGroupsResult |
describeReplicationGroups()
Simplified method form for invoking the DescribeReplicationGroups operation.
|
DescribeReplicationGroupsResult |
describeReplicationGroups(DescribeReplicationGroupsRequest request)
Returns information about a particular replication group.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
Simplified method form for invoking the DescribeReservedCacheNodes operation.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
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 request)
Lists available reserved cache node offerings.
|
DescribeServerlessCachesResult |
describeServerlessCaches(DescribeServerlessCachesRequest request)
Returns information about a specific serverless cache.
|
DescribeServerlessCacheSnapshotsResult |
describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest request)
Returns information about serverless cache snapshots.
|
DescribeServiceUpdatesResult |
describeServiceUpdates(DescribeServiceUpdatesRequest request)
Returns details of the service updates
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest request)
Returns information about cluster or replication group snapshots.
|
DescribeUpdateActionsResult |
describeUpdateActions(DescribeUpdateActionsRequest request)
Returns details of the update actions
|
DescribeUserGroupsResult |
describeUserGroups(DescribeUserGroupsRequest request)
Returns a list of user groups.
|
DescribeUsersResult |
describeUsers(DescribeUsersRequest request)
Returns a list of users.
|
GlobalReplicationGroup |
disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)
Remove a secondary cluster from the Global datastore using the Global datastore name.
|
ExportServerlessCacheSnapshotResult |
exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest request)
Provides the functionality to export the serverless cache snapshot data to Amazon S3.
|
GlobalReplicationGroup |
failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)
Used to failover the primary region to a secondary region.
|
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.
|
GlobalReplicationGroup |
increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
Increase the number of node groups in the Global datastore
|
ReplicationGroup |
increaseReplicaCount(IncreaseReplicaCountRequest request)
Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the
number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication
group.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications()
Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
Lists all available node types that you can scale your Redis OSS cluster's or replication group's current node
type.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags currently on a named resource.
|
CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest request)
Modifies the settings for a cluster.
|
ModifyCacheParameterGroupResult |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
Modifies the parameters of a cache parameter group.
|
CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
Modifies an existing cache subnet group.
|
GlobalReplicationGroup |
modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)
Modifies the settings for a Global datastore.
|
ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest request)
Modifies the settings for a replication group.
|
ReplicationGroup |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among existing shards.
|
ModifyServerlessCacheResult |
modifyServerlessCache(ModifyServerlessCacheRequest request)
This API modifies the attributes of a serverless cache.
|
ModifyUserResult |
modifyUser(ModifyUserRequest request)
Changes user password(s) and/or access string.
|
ModifyUserGroupResult |
modifyUserGroup(ModifyUserGroupRequest request)
Changes the list of users that belong to the user group.
|
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
Allows you to purchase a reserved cache node offering.
|
GlobalReplicationGroup |
rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
|
CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest request)
Reboots some, or all, of the cache nodes within a provisioned cluster.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes the tags identified by the
TagKeys list from the named resource. |
ResetCacheParameterGroupResult |
resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
Modifies the parameters of a cache parameter group to the engine or system default value.
|
CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
Revokes ingress from a cache security group.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
ReplicationGroup |
startMigration(StartMigrationRequest request)
Start the migration of data.
|
ReplicationGroup |
testFailover(TestFailoverRequest request)
Represents the input of a
TestFailover operation which tests automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
ReplicationGroup |
testMigration(TestMigrationRequest request)
Async API to test connection between source and target replication group.
|
AmazonElastiCacheWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonElastiCacheClient()
AmazonElastiCacheClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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
@Deprecated public AmazonElastiCacheClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonElastiCacheClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AmazonElastiCacheClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 static AmazonElastiCacheClientBuilder builder()
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon 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 cluster ID does not refer to an existing cluster.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an existing cache parameter group.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.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupNotFoundException
- The specified replication group does not exist.ReservedCacheNodeNotFoundException
- The requested reserved cache node was not found.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing snapshot.UserNotFoundException
- The user does not exist or could not be found.UserGroupNotFoundException
- The user group was not found or does not existServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); AddTagsToResourceRequest request = new AddTagsToResourceRequest().withResourceName("arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster") .withTags(new Tag().withKey("APIVersion").withValue("20150202"), new Tag().withKey("Service").withValue("ElastiCache")); AddTagsToResourceResult response = client.addTagsToResource(request);
public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); AuthorizeCacheSecurityGroupIngressRequest request = new AuthorizeCacheSecurityGroupIngressRequest().withCacheSecurityGroupName("my-sec-grp") .withEC2SecurityGroupName("my-ec2-sec-grp").withEC2SecurityGroupOwnerId("1234567890"); CacheSecurityGroup response = client.authorizeCacheSecurityGroupIngress(request);
public BatchApplyUpdateActionResult batchApplyUpdateAction(BatchApplyUpdateActionRequest request)
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batchApplyUpdateAction
in interface AmazonElastiCache
batchApplyUpdateActionRequest
- ServiceUpdateNotFoundException
- The service update doesn't existInvalidParameterValueException
- The value for a parameter is invalid.public BatchStopUpdateActionResult batchStopUpdateAction(BatchStopUpdateActionRequest request)
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
batchStopUpdateAction
in interface AmazonElastiCache
batchStopUpdateActionRequest
- ServiceUpdateNotFoundException
- The service update doesn't existInvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup completeMigration(CompleteMigrationRequest request)
Complete the migration of data.
completeMigration
in interface AmazonElastiCache
completeMigrationRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupNotUnderMigrationException
- The designated replication group is not available for data migration.public CopyServerlessCacheSnapshotResult copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest request)
Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.
copyServerlessCacheSnapshot
in interface AmazonElastiCache
copyServerlessCacheSnapshotRequest
- ServerlessCacheSnapshotAlreadyExistsException
- A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless
Memcached only.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.ServerlessCacheSnapshotQuotaExceededException
- The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.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.public Snapshot copySnapshot(CopySnapshotRequest request)
Makes a copy of an existing snapshot.
This operation is valid for Redis OSS 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.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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CopySnapshotRequest request = new CopySnapshotRequest().withSourceSnapshotName("my-snapshot").withTargetSnapshotName("my-snapshot-copy") .withTargetBucket(""); Snapshot response = client.copySnapshot(request);
public CacheCluster createCacheCluster(CreateCacheClusterRequest request)
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis OSS.
This operation is not supported for Redis OSS (cluster mode enabled) clusters.
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 cluster with the given identifier.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.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 clusters per customer.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes in a single
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateCacheClusterRequest request = new CreateCacheClusterRequest().withCacheClusterId("my-memcached-cluster").withAZMode("cross-az") .withNumCacheNodes(2).withCacheNodeType("cache.r3.large").withEngine("memcached").withEngineVersion("1.4.24") .withCacheSubnetGroupName("default").withPort(11211); CacheCluster response = client.createCacheCluster(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateCacheClusterRequest request = new CreateCacheClusterRequest().withCacheClusterId("my-redis").withPreferredAvailabilityZone("us-east-1c") .withNumCacheNodes(1).withCacheNodeType("cache.r3.larage").withEngine("redis").withEngineVersion("3.2.4").withCacheSubnetGroupName("default") .withPort(6379).withAutoMinorVersionUpgrade(true).withSnapshotRetentionLimit(7); CacheCluster response = client.createCacheCluster(request);
public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest request)
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 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.
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.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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateCacheParameterGroupRequest request = new CreateCacheParameterGroupRequest().withCacheParameterGroupName("custom-redis2-8") .withCacheParameterGroupFamily("redis2.8").withDescription("Custom Redis 2.8 parameter group."); CacheParameterGroup response = client.createCacheParameterGroup(request);
public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a 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.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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateCacheSecurityGroupRequest request = new CreateCacheSecurityGroupRequest().withCacheSecurityGroupName("my-cache-sec-grp").withDescription( "Example ElastiCache security group."); CacheSecurityGroup response = client.createCacheSecurityGroup(request);
public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
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.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.InvalidSubnetException
- An invalid subnet identifier was specified.SubnetNotAllowedException
- At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user
sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets
the subnet ID to an Outpost when not subscribed on this service.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateCacheSubnetGroupRequest request = new CreateCacheSubnetGroupRequest().withCacheSubnetGroupName("my-sn-grp2") .withCacheSubnetGroupDescription("Sample subnet group").withSubnetIds("subnet-6f28c982", "subnet-bcd382f3", "subnet-845b3e7c0"); CacheSubnetGroup response = client.createCacheSubnetGroup(request);
public GlobalReplicationGroup createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)
Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
createGlobalReplicationGroup
in interface AmazonElastiCache
createGlobalReplicationGroupRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.GlobalReplicationGroupAlreadyExistsException
- The Global datastore name already exists.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest request)
Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis OSS (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. If you need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling. For more information, see Scaling ElastiCache (Redis OSS) Clusters in the ElastiCache User Guide.
This operation is valid for Redis OSS only.
createReplicationGroup
in interface AmazonElastiCache
createReplicationGroupRequest
- Represents the input of a CreateReplicationGroup
operation.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException
- The requested cluster is not in the available
state.ReplicationGroupAlreadyExistsException
- The specified replication group already exists.InvalidUserGroupStateException
- The user group is not in an active state.UserGroupNotFoundException
- The user group was not found or does not existInsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.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 clusters per customer.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes in a single
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 allowed number of node groups
(shards) in a single replication group. The default maximum is 90GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateReplicationGroupRequest request = new CreateReplicationGroupRequest().withReplicationGroupId("my-redis-rg") .withReplicationGroupDescription("A Redis replication group.").withAutomaticFailoverEnabled(true).withNumCacheClusters(3) .withCacheNodeType("cache.m3.medium").withEngine("redis").withEngineVersion("2.8.24").withSnapshotRetentionLimit(30); ReplicationGroup response = client.createReplicationGroup(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateReplicationGroupRequest request = new CreateReplicationGroupRequest() .withReplicationGroupId("clustered-redis-rg") .withReplicationGroupDescription("A multi-sharded replication group") .withNumNodeGroups(2) .withNodeGroupConfiguration( new NodeGroupConfiguration().withSlots("0-8999").withReplicaCount(1).withPrimaryAvailabilityZone("us-east-1c") .withReplicaAvailabilityZones("us-east-1b"), new NodeGroupConfiguration().withSlots("9000-16383").withReplicaCount(2).withPrimaryAvailabilityZone("us-east-1a") .withReplicaAvailabilityZones("us-east-1a", "us-east-1c")).withCacheNodeType("cache.m3.medium").withEngine("redis") .withEngineVersion("3.2.4").withCacheParameterGroupName("default.redis3.2.cluster.on").withAutoMinorVersionUpgrade(true) .withSnapshotRetentionLimit(8); ReplicationGroup response = client.createReplicationGroup(request);
public CreateServerlessCacheResult createServerlessCache(CreateServerlessCacheRequest request)
Creates a serverless cache.
createServerlessCache
in interface AmazonElastiCache
createServerlessCacheRequest
- ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheAlreadyExistsException
- A serverless cache with this name already exists.ServerlessCacheQuotaForCustomerExceededException
- The number of serverless caches exceeds the customer quota.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidCredentialsException
- You must enter valid credentials.InvalidUserGroupStateException
- The user group is not in an active state.UserGroupNotFoundException
- The user group was not found or does not existTagQuotaPerResourceExceededException
- 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.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.public CreateServerlessCacheSnapshotResult createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest request)
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.
createServerlessCacheSnapshot
in interface AmazonElastiCache
createServerlessCacheSnapshotRequest
- ServerlessCacheSnapshotAlreadyExistsException
- A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless
Memcached only.ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheSnapshotQuotaExceededException
- The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and
Serverless Memcached only.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.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.public Snapshot createSnapshot(CreateSnapshotRequest request)
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis OSS 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 cluster ID does not refer to an existing cluster.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidCacheClusterStateException
- The requested 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 OSS cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis OSS.
Neither of these are supported by ElastiCache.
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.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidParameterValueException
- The value for a parameter is invalid.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateSnapshotRequest request = new CreateSnapshotRequest().withCacheClusterId("onenoderedis").withSnapshotName("snapshot-1"); Snapshot response = client.createSnapshot(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateSnapshotRequest request = new CreateSnapshotRequest().withCacheClusterId("threenoderedis-001").withSnapshotName("snapshot-2"); Snapshot response = client.createSnapshot(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); CreateSnapshotRequest request = new CreateSnapshotRequest().withReplicationGroupId("clusteredredis").withSnapshotName("snapshot-2x5"); Snapshot response = client.createSnapshot(request);
public CreateUserResult createUser(CreateUserRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access Control (RBAC).
createUser
in interface AmazonElastiCache
createUserRequest
- UserAlreadyExistsException
- A user with this ID already exists.UserQuotaExceededException
- The quota of users has been exceeded.DuplicateUserNameException
- A user with this username already exists.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.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.public CreateUserGroupResult createUserGroup(CreateUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access Control (RBAC)
createUserGroup
in interface AmazonElastiCache
createUserGroupRequest
- UserNotFoundException
- The user does not exist or could not be found.DuplicateUserNameException
- A user with this username already exists.UserGroupAlreadyExistsException
- The user group with this ID already exists.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.DefaultUserRequiredException
- You must add default user to a user group.UserGroupQuotaExceededException
- The number of users exceeds the user group limit.InvalidParameterValueException
- The value for a parameter is invalid.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.public GlobalReplicationGroup decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
Decreases the number of node groups in a Global datastore
decreaseNodeGroupsInGlobalReplicationGroup
in interface AmazonElastiCache
decreaseNodeGroupsInGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ReplicationGroup decreaseReplicaCount(DecreaseReplicaCountRequest request)
Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
decreaseReplicaCount
in interface AmazonElastiCache
decreaseReplicaCountRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.InvalidCacheClusterStateException
- The requested cluster is not in the available
state.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException
- The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.NoOperationException
- The operation was not performed because no changes were required.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest request)
Deletes a previously provisioned cluster. DeleteCacheCluster
deletes all associated cache nodes,
node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon
ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
Redis OSS (cluster mode enabled) clusters
Redis OSS (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis OSS (cluster mode enabled) replication group
A cluster that is not in the available
state
deleteCacheCluster
in interface AmazonElastiCache
deleteCacheClusterRequest
- Represents the input of a DeleteCacheCluster
operation.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException
- The requested 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 OSS cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis OSS.
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteCacheClusterRequest request = new DeleteCacheClusterRequest().withCacheClusterId("my-memcached"); CacheCluster response = client.deleteCacheCluster(request);
public DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteCacheParameterGroupRequest request = new DeleteCacheParameterGroupRequest().withCacheParameterGroupName("custom-mem1-4"); DeleteCacheParameterGroupResult response = client.deleteCacheParameterGroup(request);
public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteCacheSecurityGroupRequest request = new DeleteCacheSecurityGroupRequest().withCacheSecurityGroupName("my-sec-group"); DeleteCacheSecurityGroupResult response = client.deleteCacheSecurityGroup(request);
public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteCacheSubnetGroupRequest request = new DeleteCacheSubnetGroupRequest().withCacheSubnetGroupName("my-subnet-group"); DeleteCacheSubnetGroupResult response = client.deleteCacheSubnetGroup(request);
public GlobalReplicationGroup deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroup
API to delete the Global datastore while retainining the primary
cluster using RetainPrimaryReplicationGroup=true
.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
primary by setting RetainPrimaryReplicationGroup=true
. The primary cluster is never deleted when
deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
deleteGlobalReplicationGroup
in interface AmazonElastiCache
deleteGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest request)
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.
CreateSnapshot
permission is required to create a final snapshot. Without this permission, the API
call will fail with an Access Denied
exception.
This operation is valid for Redis OSS 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 OSS cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis OSS.
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteReplicationGroupRequest request = new DeleteReplicationGroupRequest().withReplicationGroupId("my-redis-rg").withRetainPrimaryCluster(false); ReplicationGroup response = client.deleteReplicationGroup(request);
public DeleteServerlessCacheResult deleteServerlessCache(DeleteServerlessCacheRequest request)
Deletes a specified existing serverless cache.
CreateServerlessCacheSnapshot
permission is required to create a final snapshot. Without this
permission, the API call will fail with an Access Denied
exception.
deleteServerlessCache
in interface AmazonElastiCache
deleteServerlessCacheRequest
- ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheSnapshotAlreadyExistsException
- A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless
Memcached only.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidCredentialsException
- You must enter valid credentials.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.public DeleteServerlessCacheSnapshotResult deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest request)
Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
deleteServerlessCacheSnapshot
in interface AmazonElastiCache
deleteServerlessCacheSnapshotRequest
- ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.InvalidParameterValueException
- The value for a parameter is invalid.public Snapshot deleteSnapshot(DeleteSnapshotRequest request)
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 OSS 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DeleteSnapshotRequest request = new DeleteSnapshotRequest().withSnapshotName("snapshot-20161212"); Snapshot response = client.deleteSnapshot(request);
public DeleteUserResult deleteUser(DeleteUserRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
deleteUser
in interface AmazonElastiCache
deleteUserRequest
- InvalidUserStateException
- The user is not in active state.UserNotFoundException
- The user does not exist or could not be found.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.DefaultUserAssociatedToUserGroupException
- The default user assigned to the user group.public DeleteUserGroupResult deleteUserGroup(DeleteUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
deleteUserGroup
in interface AmazonElastiCache
deleteUserGroupRequest
- UserGroupNotFoundException
- The user group was not found or does not existInvalidUserGroupStateException
- The user group is not in an active state.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest request)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the 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 cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the 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 cluster ID does not refer to an existing cluster.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheClustersRequest request = new DescribeCacheClustersRequest().withCacheClusterId("my-mem-cluster"); DescribeCacheClustersResult response = client.describeCacheClusters(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheClustersRequest request = new DescribeCacheClustersRequest().withCacheClusterId("my-mem-cluster").withShowCacheNodeInfo(true); DescribeCacheClustersResult response = client.describeCacheClusters(request);
public DescribeCacheClustersResult describeCacheClusters()
AmazonElastiCache
describeCacheClusters
in interface AmazonElastiCache
AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
Returns a list of the available cache engines and their versions.
describeCacheEngineVersions
in interface AmazonElastiCache
describeCacheEngineVersionsRequest
- Represents the input of a DescribeCacheEngineVersions
operation.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheEngineVersionsRequest request = new DescribeCacheEngineVersionsRequest(); DescribeCacheEngineVersionsResult response = client.describeCacheEngineVersions(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheEngineVersionsRequest request = new DescribeCacheEngineVersionsRequest().withEngine("redis").withMaxRecords(50).withDefaultOnly(false); DescribeCacheEngineVersionsResult response = client.describeCacheEngineVersions(request);
public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
AmazonElastiCache
describeCacheEngineVersions
in interface AmazonElastiCache
AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheParameterGroupsRequest request = new DescribeCacheParameterGroupsRequest().withCacheParameterGroupName("custom-mem1-4"); DescribeCacheParameterGroupsResult response = client.describeCacheParameterGroups(request);
public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
AmazonElastiCache
describeCacheParameterGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheParametersRequest request = new DescribeCacheParametersRequest().withCacheParameterGroupName("custom-redis2-8").withSource("user") .withMaxRecords(100); DescribeCacheParametersResult response = client.describeCacheParameters(request);
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
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. This applicable only when you have ElastiCache in Classic setup
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheSecurityGroupsRequest request = new DescribeCacheSecurityGroupsRequest().withCacheSecurityGroupName("my-sec-group"); DescribeCacheSecurityGroupsResult response = client.describeCacheSecurityGroups(request);
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
AmazonElastiCache
describeCacheSecurityGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeCacheSubnetGroupsRequest request = new DescribeCacheSubnetGroupsRequest().withMaxRecords(25); DescribeCacheSubnetGroupsResult response = client.describeCacheSubnetGroups(request);
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
AmazonElastiCache
describeCacheSubnetGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeEngineDefaultParametersRequest request = new DescribeEngineDefaultParametersRequest().withCacheParameterGroupFamily("redis2.8").withMaxRecords( 25); EngineDefaults response = client.describeEngineDefaultParameters(request);
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeEventsRequest request = new DescribeEventsRequest().withSourceType("cache-cluster").withDuration(360); DescribeEventsResult response = client.describeEvents(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeEventsRequest request = new DescribeEventsRequest().withStartTime(new Date("2016-12-22T15:00:00.000Z")); DescribeEventsResult response = client.describeEvents(request);
public DescribeEventsResult describeEvents()
AmazonElastiCache
describeEvents
in interface AmazonElastiCache
AmazonElastiCache.describeEvents(DescribeEventsRequest)
public DescribeGlobalReplicationGroupsResult describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
describeGlobalReplicationGroups
in interface AmazonElastiCache
describeGlobalReplicationGroupsRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest request)
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 OSS 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeReplicationGroupsRequest request = new DescribeReplicationGroupsRequest(); DescribeReplicationGroupsResult response = client.describeReplicationGroups(request);
public DescribeReplicationGroupsResult describeReplicationGroups()
AmazonElastiCache
describeReplicationGroups
in interface AmazonElastiCache
AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeReservedCacheNodesRequest request = new DescribeReservedCacheNodesRequest().withMaxRecords(25); DescribeReservedCacheNodesResult response = client.describeReservedCacheNodes(request);
public DescribeReservedCacheNodesResult describeReservedCacheNodes()
AmazonElastiCache
describeReservedCacheNodes
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeReservedCacheNodesOfferingsRequest request = new DescribeReservedCacheNodesOfferingsRequest().withMaxRecords(20); DescribeReservedCacheNodesOfferingsResult response = client.describeReservedCacheNodesOfferings(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeReservedCacheNodesOfferingsRequest request = new DescribeReservedCacheNodesOfferingsRequest().withReservedCacheNodesOfferingId("") .withCacheNodeType("cache.r3.large").withDuration("3").withOfferingType("Light Utilization").withMaxRecords(25); DescribeReservedCacheNodesOfferingsResult response = client.describeReservedCacheNodesOfferings(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeReservedCacheNodesOfferingsRequest request = new DescribeReservedCacheNodesOfferingsRequest() .withReservedCacheNodesOfferingId("438012d3-4052-4cc7-b2e3-8d3372e0e706").withCacheNodeType("").withDuration("").withProductDescription("") .withOfferingType("").withMaxRecords(25).withMarker(""); DescribeReservedCacheNodesOfferingsResult response = client.describeReservedCacheNodesOfferings(request);
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
AmazonElastiCache
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
public DescribeServerlessCacheSnapshotsResult describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest request)
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis OSS and Serverless Memcached only.
describeServerlessCacheSnapshots
in interface AmazonElastiCache
describeServerlessCacheSnapshotsRequest
- ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeServerlessCachesResult describeServerlessCaches(DescribeServerlessCachesRequest request)
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
describeServerlessCaches
in interface AmazonElastiCache
describeServerlessCachesRequest
- ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
Returns details of the service updates
describeServiceUpdates
in interface AmazonElastiCache
describeServiceUpdatesRequest
- ServiceUpdateNotFoundException
- The service update doesn't existInvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
Returns information about 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 OSS only.
describeSnapshots
in interface AmazonElastiCache
describeSnapshotsRequest
- Represents the input of a DescribeSnapshotsMessage
operation.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); DescribeSnapshotsRequest request = new DescribeSnapshotsRequest().withSnapshotName("snapshot-20161212"); DescribeSnapshotsResult response = client.describeSnapshots(request);
public DescribeSnapshotsResult describeSnapshots()
AmazonElastiCache
describeSnapshots
in interface AmazonElastiCache
AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)
public DescribeUpdateActionsResult describeUpdateActions(DescribeUpdateActionsRequest request)
Returns details of the update actions
describeUpdateActions
in interface AmazonElastiCache
describeUpdateActionsRequest
- InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeUserGroupsResult describeUserGroups(DescribeUserGroupsRequest request)
Returns a list of user groups.
describeUserGroups
in interface AmazonElastiCache
describeUserGroupsRequest
- UserGroupNotFoundException
- The user group was not found or does not existServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public DescribeUsersResult describeUsers(DescribeUsersRequest request)
Returns a list of users.
describeUsers
in interface AmazonElastiCache
describeUsersRequest
- UserNotFoundException
- The user does not exist or could not be found.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public GlobalReplicationGroup disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
disassociateGlobalReplicationGroup
in interface AmazonElastiCache
disassociateGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ExportServerlessCacheSnapshotResult exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest request)
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.
exportServerlessCacheSnapshot
in interface AmazonElastiCache
exportServerlessCacheSnapshotRequest
- ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.public GlobalReplicationGroup failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
failoverGlobalReplicationGroup
in interface AmazonElastiCache
failoverGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public GlobalReplicationGroup increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
Increase the number of node groups in the Global datastore
increaseNodeGroupsInGlobalReplicationGroup
in interface AmazonElastiCache
increaseNodeGroupsInGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup increaseReplicaCount(IncreaseReplicaCountRequest request)
Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
increaseReplicaCount
in interface AmazonElastiCache
increaseReplicaCountRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.InvalidCacheClusterStateException
- The requested cluster is not in the available
state.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException
- The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.NoOperationException
- The operation was not performed because no changes were required.InvalidKMSKeyException
- The KMS key supplied is not valid.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
Lists all available node types that you can scale your Redis OSS cluster's or replication group's current node type.
When you use the ModifyCacheCluster
or ModifyReplicationGroup
operations to scale 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 cluster ID does not refer to an existing 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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ListAllowedNodeTypeModificationsRequest request = new ListAllowedNodeTypeModificationsRequest().withReplicationGroupId("myreplgroup"); ListAllowedNodeTypeModificationsResult response = client.listAllowedNodeTypeModifications(request);AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ListAllowedNodeTypeModificationsRequest request = new ListAllowedNodeTypeModificationsRequest().withCacheClusterId("mycluster"); ListAllowedNodeTypeModificationsResult response = client.listAllowedNodeTypeModifications(request);
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
AmazonElastiCache
listAllowedNodeTypeModifications
in interface AmazonElastiCache
AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
If the cluster is not in the available state, ListTagsForResource
returns an error.
listTagsForResource
in interface AmazonElastiCache
listTagsForResourceRequest
- The input parameters for the ListTagsForResource
operation.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an existing cache parameter group.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.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupNotFoundException
- The specified replication group does not exist.ReservedCacheNodeNotFoundException
- The requested reserved cache node was not found.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing snapshot.UserNotFoundException
- The user does not exist or could not be found.UserGroupNotFoundException
- The user group was not found or does not existServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an existing resource.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ListTagsForResourceRequest request = new ListTagsForResourceRequest() .withResourceName("arn:aws:elasticache:us-west-2::cluster:mycluster"); ListTagsForResourceResult response = client.listTagsForResource(request);
public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest request)
Modifies the settings for a 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 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. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes in a single
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ModifyCacheClusterRequest request = new ModifyCacheClusterRequest().withCacheClusterId("redis-cluster").withApplyImmediately(true) .withSnapshotRetentionLimit(14); CacheCluster response = client.modifyCacheCluster(request);
public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
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.InvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ModifyCacheParameterGroupRequest request = new ModifyCacheParameterGroupRequest().withCacheParameterGroupName("custom-mem1-4").withParameterNameValues( new ParameterNameValue().withParameterName("binding_protocol").withParameterValue("ascii"), new ParameterNameValue().withParameterName("chunk_size").withParameterValue("96")); ModifyCacheParameterGroupResult response = client.modifyCacheParameterGroup(request);
public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
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.SubnetNotAllowedException
- At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user
sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets
the subnet ID to an Outpost when not subscribed on this service.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ModifyCacheSubnetGroupRequest request = new ModifyCacheSubnetGroupRequest().withCacheSubnetGroupName("my-sn-grp").withSubnetIds("subnet-bcde2345"); CacheSubnetGroup response = client.modifyCacheSubnetGroup(request);
public GlobalReplicationGroup modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)
Modifies the settings for a Global datastore.
modifyGlobalReplicationGroup
in interface AmazonElastiCache
modifyGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest request)
Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer.
Scaling for Amazon ElastiCache (Redis OSS) (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis OSS 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.InvalidUserGroupStateException
- The user group is not in an active state.UserGroupNotFoundException
- The user group was not found or does not existInvalidCacheClusterStateException
- The requested 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. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes in a single
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.InvalidKMSKeyException
- The KMS key supplied is not valid.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ModifyReplicationGroupRequest request = new ModifyReplicationGroupRequest().withReplicationGroupId("my-redis-rg") .withReplicationGroupDescription("Modified replication group").withSnapshottingClusterId("my-redis-rg-001").withApplyImmediately(true) .withSnapshotRetentionLimit(30); ReplicationGroup response = client.modifyReplicationGroup(request);
public ReplicationGroup modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
modifyReplicationGroupShardConfiguration
in interface AmazonElastiCache
modifyReplicationGroupShardConfigurationRequest
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.InvalidCacheClusterStateException
- The requested cluster is not in the available
state.InvalidVPCNetworkStateException
- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException
- The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.NodeGroupsPerReplicationGroupQuotaExceededException
- The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException
- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.InvalidKMSKeyException
- The KMS key supplied is not valid.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ModifyServerlessCacheResult modifyServerlessCache(ModifyServerlessCacheRequest request)
This API modifies the attributes of a serverless cache.
modifyServerlessCache
in interface AmazonElastiCache
modifyServerlessCacheRequest
- ServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.InvalidCredentialsException
- You must enter valid credentials.InvalidUserGroupStateException
- The user group is not in an active state.UserGroupNotFoundException
- The user group was not found or does not existServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.public ModifyUserResult modifyUser(ModifyUserRequest request)
Changes user password(s) and/or access string.
modifyUser
in interface AmazonElastiCache
modifyUserRequest
- UserNotFoundException
- The user does not exist or could not be found.InvalidUserStateException
- The user is not in active state.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ModifyUserGroupResult modifyUserGroup(ModifyUserGroupRequest request)
Changes the list of users that belong to the user group.
modifyUserGroup
in interface AmazonElastiCache
modifyUserGroupRequest
- UserGroupNotFoundException
- The user group was not found or does not existUserNotFoundException
- The user does not exist or could not be found.DuplicateUserNameException
- A user with this username already exists.ServiceLinkedRoleNotFoundException
- The specified service linked role (SLR) was not found.DefaultUserRequiredException
- You must add default user to a user group.InvalidUserGroupStateException
- The user group is not in an active state.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis OSS or Managing Costs with Reserved Nodes for Memcached.
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.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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); PurchaseReservedCacheNodesOfferingRequest request = new PurchaseReservedCacheNodesOfferingRequest() .withReservedCacheNodesOfferingId("1ef01f5b-94ff-433f-a530-61a56bfc8e7a"); ReservedCacheNode response = client.purchaseReservedCacheNodesOffering(request);
public GlobalReplicationGroup rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroup
in interface AmazonElastiCache
rebalanceSlotsInGlobalReplicationGroupRequest
- GlobalReplicationGroupNotFoundException
- The Global datastore does not existInvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.InvalidParameterValueException
- The value for a parameter is invalid.public CacheCluster rebootCacheCluster(RebootCacheClusterRequest request)
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the 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 cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Redis OSS (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
rebootCacheCluster
in interface AmazonElastiCache
rebootCacheClusterRequest
- Represents the input of a RebootCacheCluster
operation.InvalidCacheClusterStateException
- The requested cluster is not in the available
state.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); RebootCacheClusterRequest request = new RebootCacheClusterRequest().withCacheClusterId("custom-mem1-4 ").withCacheNodeIdsToReboot("0001", "0002"); CacheCluster response = client.rebootCacheCluster(request);
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes the tags identified by the TagKeys
list from the named resource. A tag is a key-value pair
where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache
resources, with the exception of global replication group. When you add or remove tags on replication groups,
those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
removeTagsFromResource
in interface AmazonElastiCache
removeTagsFromResourceRequest
- Represents the input of a RemoveTagsFromResource
operation.CacheClusterNotFoundException
- The requested cluster ID does not refer to an existing cluster.CacheParameterGroupNotFoundException
- The requested cache parameter group name does not refer to an existing cache parameter group.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.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupNotFoundException
- The specified replication group does not exist.ReservedCacheNodeNotFoundException
- The requested reserved cache node was not found.SnapshotNotFoundException
- The requested snapshot name does not refer to an existing snapshot.UserNotFoundException
- The user does not exist or could not be found.UserGroupNotFoundException
- The user group was not found or does not existServerlessCacheNotFoundException
- The serverless cache was not found or does not exist.InvalidServerlessCacheStateException
- The account for these credentials is not currently active.ServerlessCacheSnapshotNotFoundException
- This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and
Serverless Memcached only.InvalidServerlessCacheSnapshotStateException
- The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless
Memcached only.InvalidARNException
- The requested Amazon Resource Name (ARN) does not refer to an existing resource.TagNotFoundException
- The requested tag was not found on this resource.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); RemoveTagsFromResourceRequest request = new RemoveTagsFromResourceRequest().withResourceName( "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster").withTagKeys("A", "C", "E"); RemoveTagsFromResourceResult response = client.removeTagsFromResource(request);
public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
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.InvalidGlobalReplicationGroupStateException
- The Global datastore is not available or in primary-only state.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); ResetCacheParameterGroupRequest request = new ResetCacheParameterGroupRequest().withCacheParameterGroupName("custom-mem1-4").withResetAllParameters( true); ResetCacheParameterGroupResult response = client.resetCacheParameterGroup(request);
public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
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.AmazonElastiCache client = AmazonElastiCacheClientBuilder.standard().build(); RevokeCacheSecurityGroupIngressRequest request = new RevokeCacheSecurityGroupIngressRequest().withCacheSecurityGroupName("my-sec-grp") .withEC2SecurityGroupName("my-ec2-sec-grp").withEC2SecurityGroupOwnerId("1234567890"); CacheSecurityGroup response = client.revokeCacheSecurityGroupIngress(request);
public ReplicationGroup startMigration(StartMigrationRequest request)
Start the migration of data.
startMigration
in interface AmazonElastiCache
startMigrationRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupAlreadyUnderMigrationException
- The targeted replication group is not available.InvalidParameterValueException
- The value for a parameter is invalid.public ReplicationGroup testFailover(TestFailoverRequest request)
Represents the input of a TestFailover
operation which tests automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon 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 OSS (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 Amazon 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 primary node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from primary 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
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
testFailover
in interface AmazonElastiCache
testFailoverRequest
- APICallRateForCustomerExceededException
- The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException
- The requested 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.TestFailoverNotAvailableException
- The TestFailover
action is not available.InvalidKMSKeyException
- The KMS key supplied is not valid.InvalidParameterValueException
- The value for a parameter is invalid.InvalidParameterCombinationException
- Two or more incompatible parameters were specified.public ReplicationGroup testMigration(TestMigrationRequest request)
Async API to test connection between source and target replication group.
testMigration
in interface AmazonElastiCache
testMigrationRequest
- ReplicationGroupNotFoundException
- The specified replication group does not exist.InvalidReplicationGroupStateException
- The requested replication group is not in the available
state.ReplicationGroupAlreadyUnderMigrationException
- The targeted replication group is not available.InvalidParameterValueException
- The value for a parameter is invalid.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
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonElastiCache
shutdown
in class AmazonWebServiceClient