@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonElastiCacheAsyncClient extends AmazonElastiCacheClient implements AmazonElastiCacheAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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 |
---|
AmazonElastiCacheAsyncClient()
Deprecated.
|
AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonElastiCacheAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addTagsToResource, authorizeCacheSecurityGroupIngress, batchApplyUpdateAction, batchStopUpdateAction, builder, completeMigration, copyServerlessCacheSnapshot, copySnapshot, createCacheCluster, createCacheParameterGroup, createCacheSecurityGroup, createCacheSubnetGroup, createGlobalReplicationGroup, createReplicationGroup, createServerlessCache, createServerlessCacheSnapshot, createSnapshot, createUser, createUserGroup, decreaseNodeGroupsInGlobalReplicationGroup, decreaseReplicaCount, deleteCacheCluster, deleteCacheParameterGroup, deleteCacheSecurityGroup, deleteCacheSubnetGroup, deleteGlobalReplicationGroup, deleteReplicationGroup, deleteServerlessCache, deleteServerlessCacheSnapshot, deleteSnapshot, deleteUser, deleteUserGroup, describeCacheClusters, describeCacheClusters, describeCacheEngineVersions, describeCacheEngineVersions, describeCacheParameterGroups, describeCacheParameterGroups, describeCacheParameters, describeCacheSecurityGroups, describeCacheSecurityGroups, describeCacheSubnetGroups, describeCacheSubnetGroups, describeEngineDefaultParameters, describeEvents, describeEvents, describeGlobalReplicationGroups, describeReplicationGroups, describeReplicationGroups, describeReservedCacheNodes, describeReservedCacheNodes, describeReservedCacheNodesOfferings, describeReservedCacheNodesOfferings, describeServerlessCaches, describeServerlessCacheSnapshots, describeServiceUpdates, describeSnapshots, describeSnapshots, describeUpdateActions, describeUserGroups, describeUsers, disassociateGlobalReplicationGroup, exportServerlessCacheSnapshot, failoverGlobalReplicationGroup, getCachedResponseMetadata, increaseNodeGroupsInGlobalReplicationGroup, increaseReplicaCount, listAllowedNodeTypeModifications, listAllowedNodeTypeModifications, listTagsForResource, modifyCacheCluster, modifyCacheParameterGroup, modifyCacheSubnetGroup, modifyGlobalReplicationGroup, modifyReplicationGroup, modifyReplicationGroupShardConfiguration, modifyServerlessCache, modifyUser, modifyUserGroup, purchaseReservedCacheNodesOffering, rebalanceSlotsInGlobalReplicationGroup, rebootCacheCluster, removeTagsFromResource, resetCacheParameterGroup, revokeCacheSecurityGroupIngress, startMigration, testFailover, testMigration, 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
addTagsToResource, authorizeCacheSecurityGroupIngress, batchApplyUpdateAction, batchStopUpdateAction, completeMigration, copyServerlessCacheSnapshot, copySnapshot, createCacheCluster, createCacheParameterGroup, createCacheSecurityGroup, createCacheSubnetGroup, createGlobalReplicationGroup, createReplicationGroup, createServerlessCache, createServerlessCacheSnapshot, createSnapshot, createUser, createUserGroup, decreaseNodeGroupsInGlobalReplicationGroup, decreaseReplicaCount, deleteCacheCluster, deleteCacheParameterGroup, deleteCacheSecurityGroup, deleteCacheSubnetGroup, deleteGlobalReplicationGroup, deleteReplicationGroup, deleteServerlessCache, deleteServerlessCacheSnapshot, deleteSnapshot, deleteUser, deleteUserGroup, describeCacheClusters, describeCacheClusters, describeCacheEngineVersions, describeCacheEngineVersions, describeCacheParameterGroups, describeCacheParameterGroups, describeCacheParameters, describeCacheSecurityGroups, describeCacheSecurityGroups, describeCacheSubnetGroups, describeCacheSubnetGroups, describeEngineDefaultParameters, describeEvents, describeEvents, describeGlobalReplicationGroups, describeReplicationGroups, describeReplicationGroups, describeReservedCacheNodes, describeReservedCacheNodes, describeReservedCacheNodesOfferings, describeReservedCacheNodesOfferings, describeServerlessCaches, describeServerlessCacheSnapshots, describeServiceUpdates, describeSnapshots, describeSnapshots, describeUpdateActions, describeUserGroups, describeUsers, disassociateGlobalReplicationGroup, exportServerlessCacheSnapshot, failoverGlobalReplicationGroup, getCachedResponseMetadata, increaseNodeGroupsInGlobalReplicationGroup, increaseReplicaCount, listAllowedNodeTypeModifications, listAllowedNodeTypeModifications, listTagsForResource, modifyCacheCluster, modifyCacheParameterGroup, modifyCacheSubnetGroup, modifyGlobalReplicationGroup, modifyReplicationGroup, modifyReplicationGroupShardConfiguration, modifyServerlessCache, modifyUser, modifyUserGroup, purchaseReservedCacheNodesOffering, rebalanceSlotsInGlobalReplicationGroup, rebootCacheCluster, removeTagsFromResource, resetCacheParameterGroup, revokeCacheSecurityGroupIngress, setEndpoint, setRegion, startMigration, testFailover, testMigration, waiters
@Deprecated public AmazonElastiCacheAsyncClient()
AmazonElastiCacheAsyncClientBuilder.defaultClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonElastiCacheAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon ElastiCache (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonElastiCacheAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.public static AmazonElastiCacheAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
AmazonElastiCacheAsync
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.
addTagsToResourceAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of an AddTagsToResource operation.public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
AmazonElastiCacheAsync
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.
addTagsToResourceAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of an AddTagsToResource operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheSecurityGroup> authorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest request)
AmazonElastiCacheAsync
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.
authorizeCacheSecurityGroupIngressAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.public Future<CacheSecurityGroup> authorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest request, AsyncHandler<AuthorizeCacheSecurityGroupIngressRequest,CacheSecurityGroup> asyncHandler)
AmazonElastiCacheAsync
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.
authorizeCacheSecurityGroupIngressAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchApplyUpdateActionResult> batchApplyUpdateActionAsync(BatchApplyUpdateActionRequest request)
AmazonElastiCacheAsync
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batchApplyUpdateActionAsync
in interface AmazonElastiCacheAsync
public Future<BatchApplyUpdateActionResult> batchApplyUpdateActionAsync(BatchApplyUpdateActionRequest request, AsyncHandler<BatchApplyUpdateActionRequest,BatchApplyUpdateActionResult> asyncHandler)
AmazonElastiCacheAsync
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batchApplyUpdateActionAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchStopUpdateActionResult> batchStopUpdateActionAsync(BatchStopUpdateActionRequest request)
AmazonElastiCacheAsync
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
batchStopUpdateActionAsync
in interface AmazonElastiCacheAsync
public Future<BatchStopUpdateActionResult> batchStopUpdateActionAsync(BatchStopUpdateActionRequest request, AsyncHandler<BatchStopUpdateActionRequest,BatchStopUpdateActionResult> asyncHandler)
AmazonElastiCacheAsync
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
batchStopUpdateActionAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> completeMigrationAsync(CompleteMigrationRequest request)
AmazonElastiCacheAsync
Complete the migration of data.
completeMigrationAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> completeMigrationAsync(CompleteMigrationRequest request, AsyncHandler<CompleteMigrationRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Complete the migration of data.
completeMigrationAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CopyServerlessCacheSnapshotResult> copyServerlessCacheSnapshotAsync(CopyServerlessCacheSnapshotRequest request)
AmazonElastiCacheAsync
Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.
copyServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
public Future<CopyServerlessCacheSnapshotResult> copyServerlessCacheSnapshotAsync(CopyServerlessCacheSnapshotRequest request, AsyncHandler<CopyServerlessCacheSnapshotRequest,CopyServerlessCacheSnapshotResult> asyncHandler)
AmazonElastiCacheAsync
Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.
copyServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<Snapshot> copySnapshotAsync(CopySnapshotRequest request)
AmazonElastiCacheAsync
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.
copySnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CopySnapshotMessage
operation.public Future<Snapshot> copySnapshotAsync(CopySnapshotRequest request, AsyncHandler<CopySnapshotRequest,Snapshot> asyncHandler)
AmazonElastiCacheAsync
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.
copySnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CopySnapshotMessage
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheCluster> createCacheClusterAsync(CreateCacheClusterRequest request)
AmazonElastiCacheAsync
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.
createCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheCluster operation.public Future<CacheCluster> createCacheClusterAsync(CreateCacheClusterRequest request, AsyncHandler<CreateCacheClusterRequest,CacheCluster> asyncHandler)
AmazonElastiCacheAsync
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.
createCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheCluster operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheParameterGroup> createCacheParameterGroupAsync(CreateCacheParameterGroupRequest request)
AmazonElastiCacheAsync
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.
createCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheParameterGroup
operation.public Future<CacheParameterGroup> createCacheParameterGroupAsync(CreateCacheParameterGroupRequest request, AsyncHandler<CreateCacheParameterGroupRequest,CacheParameterGroup> asyncHandler)
AmazonElastiCacheAsync
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.
createCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheParameterGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheSecurityGroup> createCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest request)
AmazonElastiCacheAsync
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.
createCacheSecurityGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheSecurityGroup
operation.public Future<CacheSecurityGroup> createCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest request, AsyncHandler<CreateCacheSecurityGroupRequest,CacheSecurityGroup> asyncHandler)
AmazonElastiCacheAsync
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.
createCacheSecurityGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheSecurityGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheSubnetGroup> createCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest request)
AmazonElastiCacheAsync
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheSubnetGroup
operation.public Future<CacheSubnetGroup> createCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest request, AsyncHandler<CreateCacheSubnetGroupRequest,CacheSubnetGroup> asyncHandler)
AmazonElastiCacheAsync
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateCacheSubnetGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> createGlobalReplicationGroupAsync(CreateGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
createGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> createGlobalReplicationGroupAsync(CreateGlobalReplicationGroupRequest request, AsyncHandler<CreateGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
createGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> createReplicationGroupAsync(CreateReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
createReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateReplicationGroup
operation.public Future<ReplicationGroup> createReplicationGroupAsync(CreateReplicationGroupRequest request, AsyncHandler<CreateReplicationGroupRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
createReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateReplicationGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateServerlessCacheResult> createServerlessCacheAsync(CreateServerlessCacheRequest request)
AmazonElastiCacheAsync
Creates a serverless cache.
createServerlessCacheAsync
in interface AmazonElastiCacheAsync
public Future<CreateServerlessCacheResult> createServerlessCacheAsync(CreateServerlessCacheRequest request, AsyncHandler<CreateServerlessCacheRequest,CreateServerlessCacheResult> asyncHandler)
AmazonElastiCacheAsync
Creates a serverless cache.
createServerlessCacheAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateServerlessCacheSnapshotResult> createServerlessCacheSnapshotAsync(CreateServerlessCacheSnapshotRequest request)
AmazonElastiCacheAsync
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.
createServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
public Future<CreateServerlessCacheSnapshotResult> createServerlessCacheSnapshotAsync(CreateServerlessCacheSnapshotRequest request, AsyncHandler<CreateServerlessCacheSnapshotRequest,CreateServerlessCacheSnapshotResult> asyncHandler)
AmazonElastiCacheAsync
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.
createServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<Snapshot> createSnapshotAsync(CreateSnapshotRequest request)
AmazonElastiCacheAsync
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis OSS only.
createSnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateSnapshot
operation.public Future<Snapshot> createSnapshotAsync(CreateSnapshotRequest request, AsyncHandler<CreateSnapshotRequest,Snapshot> asyncHandler)
AmazonElastiCacheAsync
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis OSS only.
createSnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a CreateSnapshot
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AmazonElastiCacheAsync
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access Control (RBAC).
createUserAsync
in interface AmazonElastiCacheAsync
public Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AmazonElastiCacheAsync
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access Control (RBAC).
createUserAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserGroupResult> createUserGroupAsync(CreateUserGroupRequest request)
AmazonElastiCacheAsync
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access Control (RBAC)
createUserGroupAsync
in interface AmazonElastiCacheAsync
public Future<CreateUserGroupResult> createUserGroupAsync(CreateUserGroupRequest request, AsyncHandler<CreateUserGroupRequest,CreateUserGroupResult> asyncHandler)
AmazonElastiCacheAsync
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access Control (RBAC)
createUserGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> decreaseNodeGroupsInGlobalReplicationGroupAsync(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
Decreases the number of node groups in a Global datastore
decreaseNodeGroupsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> decreaseNodeGroupsInGlobalReplicationGroupAsync(DecreaseNodeGroupsInGlobalReplicationGroupRequest request, AsyncHandler<DecreaseNodeGroupsInGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Decreases the number of node groups in a Global datastore
decreaseNodeGroupsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> decreaseReplicaCountAsync(DecreaseReplicaCountRequest request)
AmazonElastiCacheAsync
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.
decreaseReplicaCountAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> decreaseReplicaCountAsync(DecreaseReplicaCountRequest request, AsyncHandler<DecreaseReplicaCountRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
decreaseReplicaCountAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheCluster> deleteCacheClusterAsync(DeleteCacheClusterRequest request)
AmazonElastiCacheAsync
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
deleteCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheCluster
operation.public Future<CacheCluster> deleteCacheClusterAsync(DeleteCacheClusterRequest request, AsyncHandler<DeleteCacheClusterRequest,CacheCluster> asyncHandler)
AmazonElastiCacheAsync
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
deleteCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheCluster
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCacheParameterGroupResult> deleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest request)
AmazonElastiCacheAsync
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.
deleteCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheParameterGroup
operation.public Future<DeleteCacheParameterGroupResult> deleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest request, AsyncHandler<DeleteCacheParameterGroupRequest,DeleteCacheParameterGroupResult> asyncHandler)
AmazonElastiCacheAsync
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.
deleteCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheParameterGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCacheSecurityGroupResult> deleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest request)
AmazonElastiCacheAsync
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
deleteCacheSecurityGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheSecurityGroup
operation.public Future<DeleteCacheSecurityGroupResult> deleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest request, AsyncHandler<DeleteCacheSecurityGroupRequest,DeleteCacheSecurityGroupResult> asyncHandler)
AmazonElastiCacheAsync
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
deleteCacheSecurityGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheSecurityGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCacheSubnetGroupResult> deleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest request)
AmazonElastiCacheAsync
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
deleteCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheSubnetGroup
operation.public Future<DeleteCacheSubnetGroupResult> deleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest request, AsyncHandler<DeleteCacheSubnetGroupRequest,DeleteCacheSubnetGroupResult> asyncHandler)
AmazonElastiCacheAsync
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
deleteCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteCacheSubnetGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> deleteGlobalReplicationGroupAsync(DeleteGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
deleteGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> deleteGlobalReplicationGroupAsync(DeleteGlobalReplicationGroupRequest request, AsyncHandler<DeleteGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
deleteGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> deleteReplicationGroupAsync(DeleteReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
deleteReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteReplicationGroup
operation.public Future<ReplicationGroup> deleteReplicationGroupAsync(DeleteReplicationGroupRequest request, AsyncHandler<DeleteReplicationGroupRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
deleteReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteReplicationGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteServerlessCacheResult> deleteServerlessCacheAsync(DeleteServerlessCacheRequest request)
AmazonElastiCacheAsync
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.
deleteServerlessCacheAsync
in interface AmazonElastiCacheAsync
public Future<DeleteServerlessCacheResult> deleteServerlessCacheAsync(DeleteServerlessCacheRequest request, AsyncHandler<DeleteServerlessCacheRequest,DeleteServerlessCacheResult> asyncHandler)
AmazonElastiCacheAsync
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.
deleteServerlessCacheAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteServerlessCacheSnapshotResult> deleteServerlessCacheSnapshotAsync(DeleteServerlessCacheSnapshotRequest request)
AmazonElastiCacheAsync
Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
deleteServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
public Future<DeleteServerlessCacheSnapshotResult> deleteServerlessCacheSnapshotAsync(DeleteServerlessCacheSnapshotRequest request, AsyncHandler<DeleteServerlessCacheSnapshotRequest,DeleteServerlessCacheSnapshotResult> asyncHandler)
AmazonElastiCacheAsync
Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
deleteServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<Snapshot> deleteSnapshotAsync(DeleteSnapshotRequest request)
AmazonElastiCacheAsync
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.
deleteSnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteSnapshot
operation.public Future<Snapshot> deleteSnapshotAsync(DeleteSnapshotRequest request, AsyncHandler<DeleteSnapshotRequest,Snapshot> asyncHandler)
AmazonElastiCacheAsync
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.
deleteSnapshotAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DeleteSnapshot
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonElastiCacheAsync
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).
deleteUserAsync
in interface AmazonElastiCacheAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonElastiCacheAsync
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).
deleteUserAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserGroupResult> deleteUserGroupAsync(DeleteUserGroupRequest request)
AmazonElastiCacheAsync
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).
deleteUserGroupAsync
in interface AmazonElastiCacheAsync
public Future<DeleteUserGroupResult> deleteUserGroupAsync(DeleteUserGroupRequest request, AsyncHandler<DeleteUserGroupRequest,DeleteUserGroupResult> asyncHandler)
AmazonElastiCacheAsync
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).
deleteUserGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheClustersResult> describeCacheClustersAsync(DescribeCacheClustersRequest request)
AmazonElastiCacheAsync
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.
describeCacheClustersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheClusters
operation.public Future<DescribeCacheClustersResult> describeCacheClustersAsync(DescribeCacheClustersRequest request, AsyncHandler<DescribeCacheClustersRequest,DescribeCacheClustersResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeCacheClustersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheClusters
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheClustersResult> describeCacheClustersAsync()
describeCacheClustersAsync
in interface AmazonElastiCacheAsync
describeCacheClustersAsync(DescribeCacheClustersRequest)
public Future<DescribeCacheClustersResult> describeCacheClustersAsync(AsyncHandler<DescribeCacheClustersRequest,DescribeCacheClustersResult> asyncHandler)
describeCacheClustersAsync
in interface AmazonElastiCacheAsync
describeCacheClustersAsync(DescribeCacheClustersRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeCacheEngineVersionsResult> describeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest request)
AmazonElastiCacheAsync
Returns a list of the available cache engines and their versions.
describeCacheEngineVersionsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheEngineVersions
operation.public Future<DescribeCacheEngineVersionsResult> describeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest request, AsyncHandler<DescribeCacheEngineVersionsRequest,DescribeCacheEngineVersionsResult> asyncHandler)
AmazonElastiCacheAsync
Returns a list of the available cache engines and their versions.
describeCacheEngineVersionsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheEngineVersions
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheEngineVersionsResult> describeCacheEngineVersionsAsync()
describeCacheEngineVersionsAsync
in interface AmazonElastiCacheAsync
describeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest)
public Future<DescribeCacheEngineVersionsResult> describeCacheEngineVersionsAsync(AsyncHandler<DescribeCacheEngineVersionsRequest,DescribeCacheEngineVersionsResult> asyncHandler)
public Future<DescribeCacheParameterGroupsResult> describeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest request)
AmazonElastiCacheAsync
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.
describeCacheParameterGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheParameterGroups
operation.public Future<DescribeCacheParameterGroupsResult> describeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest request, AsyncHandler<DescribeCacheParameterGroupsRequest,DescribeCacheParameterGroupsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeCacheParameterGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheParameterGroups
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheParameterGroupsResult> describeCacheParameterGroupsAsync()
describeCacheParameterGroupsAsync
in interface AmazonElastiCacheAsync
describeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest)
public Future<DescribeCacheParameterGroupsResult> describeCacheParameterGroupsAsync(AsyncHandler<DescribeCacheParameterGroupsRequest,DescribeCacheParameterGroupsResult> asyncHandler)
public Future<DescribeCacheParametersResult> describeCacheParametersAsync(DescribeCacheParametersRequest request)
AmazonElastiCacheAsync
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheParameters
operation.public Future<DescribeCacheParametersResult> describeCacheParametersAsync(DescribeCacheParametersRequest request, AsyncHandler<DescribeCacheParametersRequest,DescribeCacheParametersResult> asyncHandler)
AmazonElastiCacheAsync
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheParameters
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheSecurityGroupsResult> describeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest request)
AmazonElastiCacheAsync
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
describeCacheSecurityGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheSecurityGroups
operation.public Future<DescribeCacheSecurityGroupsResult> describeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest request, AsyncHandler<DescribeCacheSecurityGroupsRequest,DescribeCacheSecurityGroupsResult> asyncHandler)
AmazonElastiCacheAsync
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
describeCacheSecurityGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheSecurityGroups
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheSecurityGroupsResult> describeCacheSecurityGroupsAsync()
describeCacheSecurityGroupsAsync
in interface AmazonElastiCacheAsync
describeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest)
public Future<DescribeCacheSecurityGroupsResult> describeCacheSecurityGroupsAsync(AsyncHandler<DescribeCacheSecurityGroupsRequest,DescribeCacheSecurityGroupsResult> asyncHandler)
public Future<DescribeCacheSubnetGroupsResult> describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest request)
AmazonElastiCacheAsync
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.
describeCacheSubnetGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheSubnetGroups
operation.public Future<DescribeCacheSubnetGroupsResult> describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest request, AsyncHandler<DescribeCacheSubnetGroupsRequest,DescribeCacheSubnetGroupsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeCacheSubnetGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeCacheSubnetGroups
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCacheSubnetGroupsResult> describeCacheSubnetGroupsAsync()
describeCacheSubnetGroupsAsync
in interface AmazonElastiCacheAsync
describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest)
public Future<DescribeCacheSubnetGroupsResult> describeCacheSubnetGroupsAsync(AsyncHandler<DescribeCacheSubnetGroupsRequest,DescribeCacheSubnetGroupsResult> asyncHandler)
describeCacheSubnetGroupsAsync
in interface AmazonElastiCacheAsync
describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest request)
AmazonElastiCacheAsync
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeEngineDefaultParameters
operation.public Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest request, AsyncHandler<DescribeEngineDefaultParametersRequest,EngineDefaults> asyncHandler)
AmazonElastiCacheAsync
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeEngineDefaultParameters
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request)
AmazonElastiCacheAsync
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.
describeEventsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeEvents
operation.public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeEventsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeEvents
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventsResult> describeEventsAsync()
describeEventsAsync
in interface AmazonElastiCacheAsync
describeEventsAsync(DescribeEventsRequest)
public Future<DescribeEventsResult> describeEventsAsync(AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
describeEventsAsync
in interface AmazonElastiCacheAsync
describeEventsAsync(DescribeEventsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeGlobalReplicationGroupsResult> describeGlobalReplicationGroupsAsync(DescribeGlobalReplicationGroupsRequest request)
AmazonElastiCacheAsync
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
describeGlobalReplicationGroupsAsync
in interface AmazonElastiCacheAsync
public Future<DescribeGlobalReplicationGroupsResult> describeGlobalReplicationGroupsAsync(DescribeGlobalReplicationGroupsRequest request, AsyncHandler<DescribeGlobalReplicationGroupsRequest,DescribeGlobalReplicationGroupsResult> asyncHandler)
AmazonElastiCacheAsync
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
describeGlobalReplicationGroupsAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReplicationGroupsResult> describeReplicationGroupsAsync(DescribeReplicationGroupsRequest request)
AmazonElastiCacheAsync
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.
describeReplicationGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReplicationGroups
operation.public Future<DescribeReplicationGroupsResult> describeReplicationGroupsAsync(DescribeReplicationGroupsRequest request, AsyncHandler<DescribeReplicationGroupsRequest,DescribeReplicationGroupsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeReplicationGroupsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReplicationGroups
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReplicationGroupsResult> describeReplicationGroupsAsync()
describeReplicationGroupsAsync
in interface AmazonElastiCacheAsync
describeReplicationGroupsAsync(DescribeReplicationGroupsRequest)
public Future<DescribeReplicationGroupsResult> describeReplicationGroupsAsync(AsyncHandler<DescribeReplicationGroupsRequest,DescribeReplicationGroupsResult> asyncHandler)
describeReplicationGroupsAsync
in interface AmazonElastiCacheAsync
describeReplicationGroupsAsync(DescribeReplicationGroupsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeReservedCacheNodesResult> describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest request)
AmazonElastiCacheAsync
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReservedCacheNodes
operation.public Future<DescribeReservedCacheNodesResult> describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest request, AsyncHandler<DescribeReservedCacheNodesRequest,DescribeReservedCacheNodesResult> asyncHandler)
AmazonElastiCacheAsync
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReservedCacheNodes
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReservedCacheNodesResult> describeReservedCacheNodesAsync()
describeReservedCacheNodesAsync
in interface AmazonElastiCacheAsync
describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest)
public Future<DescribeReservedCacheNodesResult> describeReservedCacheNodesAsync(AsyncHandler<DescribeReservedCacheNodesRequest,DescribeReservedCacheNodesResult> asyncHandler)
describeReservedCacheNodesAsync
in interface AmazonElastiCacheAsync
describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeReservedCacheNodesOfferingsResult> describeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest request)
AmazonElastiCacheAsync
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReservedCacheNodesOfferings
operation.public Future<DescribeReservedCacheNodesOfferingsResult> describeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest request, AsyncHandler<DescribeReservedCacheNodesOfferingsRequest,DescribeReservedCacheNodesOfferingsResult> asyncHandler)
AmazonElastiCacheAsync
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeReservedCacheNodesOfferings
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReservedCacheNodesOfferingsResult> describeReservedCacheNodesOfferingsAsync()
describeReservedCacheNodesOfferingsAsync
in interface AmazonElastiCacheAsync
describeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest)
public Future<DescribeReservedCacheNodesOfferingsResult> describeReservedCacheNodesOfferingsAsync(AsyncHandler<DescribeReservedCacheNodesOfferingsRequest,DescribeReservedCacheNodesOfferingsResult> asyncHandler)
public Future<DescribeServerlessCacheSnapshotsResult> describeServerlessCacheSnapshotsAsync(DescribeServerlessCacheSnapshotsRequest request)
AmazonElastiCacheAsync
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.
describeServerlessCacheSnapshotsAsync
in interface AmazonElastiCacheAsync
public Future<DescribeServerlessCacheSnapshotsResult> describeServerlessCacheSnapshotsAsync(DescribeServerlessCacheSnapshotsRequest request, AsyncHandler<DescribeServerlessCacheSnapshotsRequest,DescribeServerlessCacheSnapshotsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeServerlessCacheSnapshotsAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeServerlessCachesResult> describeServerlessCachesAsync(DescribeServerlessCachesRequest request)
AmazonElastiCacheAsync
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.
describeServerlessCachesAsync
in interface AmazonElastiCacheAsync
public Future<DescribeServerlessCachesResult> describeServerlessCachesAsync(DescribeServerlessCachesRequest request, AsyncHandler<DescribeServerlessCachesRequest,DescribeServerlessCachesResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeServerlessCachesAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeServiceUpdatesResult> describeServiceUpdatesAsync(DescribeServiceUpdatesRequest request)
AmazonElastiCacheAsync
Returns details of the service updates
describeServiceUpdatesAsync
in interface AmazonElastiCacheAsync
public Future<DescribeServiceUpdatesResult> describeServiceUpdatesAsync(DescribeServiceUpdatesRequest request, AsyncHandler<DescribeServiceUpdatesRequest,DescribeServiceUpdatesResult> asyncHandler)
AmazonElastiCacheAsync
Returns details of the service updates
describeServiceUpdatesAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSnapshotsResult> describeSnapshotsAsync(DescribeSnapshotsRequest request)
AmazonElastiCacheAsync
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.
describeSnapshotsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeSnapshotsMessage
operation.public Future<DescribeSnapshotsResult> describeSnapshotsAsync(DescribeSnapshotsRequest request, AsyncHandler<DescribeSnapshotsRequest,DescribeSnapshotsResult> asyncHandler)
AmazonElastiCacheAsync
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.
describeSnapshotsAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a DescribeSnapshotsMessage
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSnapshotsResult> describeSnapshotsAsync()
describeSnapshotsAsync
in interface AmazonElastiCacheAsync
describeSnapshotsAsync(DescribeSnapshotsRequest)
public Future<DescribeSnapshotsResult> describeSnapshotsAsync(AsyncHandler<DescribeSnapshotsRequest,DescribeSnapshotsResult> asyncHandler)
describeSnapshotsAsync
in interface AmazonElastiCacheAsync
describeSnapshotsAsync(DescribeSnapshotsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DescribeUpdateActionsResult> describeUpdateActionsAsync(DescribeUpdateActionsRequest request)
AmazonElastiCacheAsync
Returns details of the update actions
describeUpdateActionsAsync
in interface AmazonElastiCacheAsync
public Future<DescribeUpdateActionsResult> describeUpdateActionsAsync(DescribeUpdateActionsRequest request, AsyncHandler<DescribeUpdateActionsRequest,DescribeUpdateActionsResult> asyncHandler)
AmazonElastiCacheAsync
Returns details of the update actions
describeUpdateActionsAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserGroupsResult> describeUserGroupsAsync(DescribeUserGroupsRequest request)
AmazonElastiCacheAsync
Returns a list of user groups.
describeUserGroupsAsync
in interface AmazonElastiCacheAsync
public Future<DescribeUserGroupsResult> describeUserGroupsAsync(DescribeUserGroupsRequest request, AsyncHandler<DescribeUserGroupsRequest,DescribeUserGroupsResult> asyncHandler)
AmazonElastiCacheAsync
Returns a list of user groups.
describeUserGroupsAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest request)
AmazonElastiCacheAsync
Returns a list of users.
describeUsersAsync
in interface AmazonElastiCacheAsync
public Future<DescribeUsersResult> describeUsersAsync(DescribeUsersRequest request, AsyncHandler<DescribeUsersRequest,DescribeUsersResult> asyncHandler)
AmazonElastiCacheAsync
Returns a list of users.
describeUsersAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> disassociateGlobalReplicationGroupAsync(DisassociateGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
disassociateGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> disassociateGlobalReplicationGroupAsync(DisassociateGlobalReplicationGroupRequest request, AsyncHandler<DisassociateGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
disassociateGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ExportServerlessCacheSnapshotResult> exportServerlessCacheSnapshotAsync(ExportServerlessCacheSnapshotRequest request)
AmazonElastiCacheAsync
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.
exportServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
public Future<ExportServerlessCacheSnapshotResult> exportServerlessCacheSnapshotAsync(ExportServerlessCacheSnapshotRequest request, AsyncHandler<ExportServerlessCacheSnapshotRequest,ExportServerlessCacheSnapshotResult> asyncHandler)
AmazonElastiCacheAsync
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.
exportServerlessCacheSnapshotAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> failoverGlobalReplicationGroupAsync(FailoverGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
failoverGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> failoverGlobalReplicationGroupAsync(FailoverGlobalReplicationGroupRequest request, AsyncHandler<FailoverGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
failoverGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> increaseNodeGroupsInGlobalReplicationGroupAsync(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
Increase the number of node groups in the Global datastore
increaseNodeGroupsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> increaseNodeGroupsInGlobalReplicationGroupAsync(IncreaseNodeGroupsInGlobalReplicationGroupRequest request, AsyncHandler<IncreaseNodeGroupsInGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Increase the number of node groups in the Global datastore
increaseNodeGroupsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> increaseReplicaCountAsync(IncreaseReplicaCountRequest request)
AmazonElastiCacheAsync
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.
increaseReplicaCountAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> increaseReplicaCountAsync(IncreaseReplicaCountRequest request, AsyncHandler<IncreaseReplicaCountRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
increaseReplicaCountAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAllowedNodeTypeModificationsResult> listAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest request)
AmazonElastiCacheAsync
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.
listAllowedNodeTypeModificationsAsync
in interface AmazonElastiCacheAsync
request
- The input parameters for the ListAllowedNodeTypeModifications
operation.public Future<ListAllowedNodeTypeModificationsResult> listAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest request, AsyncHandler<ListAllowedNodeTypeModificationsRequest,ListAllowedNodeTypeModificationsResult> asyncHandler)
AmazonElastiCacheAsync
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.
listAllowedNodeTypeModificationsAsync
in interface AmazonElastiCacheAsync
request
- The input parameters for the ListAllowedNodeTypeModifications
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAllowedNodeTypeModificationsResult> listAllowedNodeTypeModificationsAsync()
listAllowedNodeTypeModificationsAsync
in interface AmazonElastiCacheAsync
listAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest)
public Future<ListAllowedNodeTypeModificationsResult> listAllowedNodeTypeModificationsAsync(AsyncHandler<ListAllowedNodeTypeModificationsRequest,ListAllowedNodeTypeModificationsResult> asyncHandler)
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonElastiCacheAsync
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.
listTagsForResourceAsync
in interface AmazonElastiCacheAsync
request
- The input parameters for the ListTagsForResource
operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonElastiCacheAsync
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.
listTagsForResourceAsync
in interface AmazonElastiCacheAsync
request
- The input parameters for the ListTagsForResource
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheCluster> modifyCacheClusterAsync(ModifyCacheClusterRequest request)
AmazonElastiCacheAsync
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.
modifyCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheCluster
operation.public Future<CacheCluster> modifyCacheClusterAsync(ModifyCacheClusterRequest request, AsyncHandler<ModifyCacheClusterRequest,CacheCluster> asyncHandler)
AmazonElastiCacheAsync
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.
modifyCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheCluster
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyCacheParameterGroupResult> modifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest request)
AmazonElastiCacheAsync
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.
modifyCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheParameterGroup
operation.public Future<ModifyCacheParameterGroupResult> modifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest request, AsyncHandler<ModifyCacheParameterGroupRequest,ModifyCacheParameterGroupResult> asyncHandler)
AmazonElastiCacheAsync
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.
modifyCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheParameterGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheSubnetGroup> modifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest request)
AmazonElastiCacheAsync
Modifies an existing cache subnet group.
modifyCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheSubnetGroup
operation.public Future<CacheSubnetGroup> modifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest request, AsyncHandler<ModifyCacheSubnetGroupRequest,CacheSubnetGroup> asyncHandler)
AmazonElastiCacheAsync
Modifies an existing cache subnet group.
modifyCacheSubnetGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyCacheSubnetGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> modifyGlobalReplicationGroupAsync(ModifyGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
Modifies the settings for a Global datastore.
modifyGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> modifyGlobalReplicationGroupAsync(ModifyGlobalReplicationGroupRequest request, AsyncHandler<ModifyGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Modifies the settings for a Global datastore.
modifyGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> modifyReplicationGroupAsync(ModifyReplicationGroupRequest request)
AmazonElastiCacheAsync
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.
modifyReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyReplicationGroups
operation.public Future<ReplicationGroup> modifyReplicationGroupAsync(ModifyReplicationGroupRequest request, AsyncHandler<ModifyReplicationGroupRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
modifyReplicationGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ModifyReplicationGroups
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> modifyReplicationGroupShardConfigurationAsync(ModifyReplicationGroupShardConfigurationRequest request)
AmazonElastiCacheAsync
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
modifyReplicationGroupShardConfigurationAsync
in interface AmazonElastiCacheAsync
request
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.public Future<ReplicationGroup> modifyReplicationGroupShardConfigurationAsync(ModifyReplicationGroupShardConfigurationRequest request, AsyncHandler<ModifyReplicationGroupShardConfigurationRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
modifyReplicationGroupShardConfigurationAsync
in interface AmazonElastiCacheAsync
request
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyServerlessCacheResult> modifyServerlessCacheAsync(ModifyServerlessCacheRequest request)
AmazonElastiCacheAsync
This API modifies the attributes of a serverless cache.
modifyServerlessCacheAsync
in interface AmazonElastiCacheAsync
public Future<ModifyServerlessCacheResult> modifyServerlessCacheAsync(ModifyServerlessCacheRequest request, AsyncHandler<ModifyServerlessCacheRequest,ModifyServerlessCacheResult> asyncHandler)
AmazonElastiCacheAsync
This API modifies the attributes of a serverless cache.
modifyServerlessCacheAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyUserResult> modifyUserAsync(ModifyUserRequest request)
AmazonElastiCacheAsync
Changes user password(s) and/or access string.
modifyUserAsync
in interface AmazonElastiCacheAsync
public Future<ModifyUserResult> modifyUserAsync(ModifyUserRequest request, AsyncHandler<ModifyUserRequest,ModifyUserResult> asyncHandler)
AmazonElastiCacheAsync
Changes user password(s) and/or access string.
modifyUserAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyUserGroupResult> modifyUserGroupAsync(ModifyUserGroupRequest request)
AmazonElastiCacheAsync
Changes the list of users that belong to the user group.
modifyUserGroupAsync
in interface AmazonElastiCacheAsync
public Future<ModifyUserGroupResult> modifyUserGroupAsync(ModifyUserGroupRequest request, AsyncHandler<ModifyUserGroupRequest,ModifyUserGroupResult> asyncHandler)
AmazonElastiCacheAsync
Changes the list of users that belong to the user group.
modifyUserGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReservedCacheNode> purchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest request)
AmazonElastiCacheAsync
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.
purchaseReservedCacheNodesOfferingAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a PurchaseReservedCacheNodesOffering
operation.public Future<ReservedCacheNode> purchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest request, AsyncHandler<PurchaseReservedCacheNodesOfferingRequest,ReservedCacheNode> asyncHandler)
AmazonElastiCacheAsync
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.
purchaseReservedCacheNodesOfferingAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a PurchaseReservedCacheNodesOffering
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalReplicationGroup> rebalanceSlotsInGlobalReplicationGroupAsync(RebalanceSlotsInGlobalReplicationGroupRequest request)
AmazonElastiCacheAsync
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
public Future<GlobalReplicationGroup> rebalanceSlotsInGlobalReplicationGroupAsync(RebalanceSlotsInGlobalReplicationGroupRequest request, AsyncHandler<RebalanceSlotsInGlobalReplicationGroupRequest,GlobalReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroupAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheCluster> rebootCacheClusterAsync(RebootCacheClusterRequest request)
AmazonElastiCacheAsync
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.
rebootCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RebootCacheCluster
operation.public Future<CacheCluster> rebootCacheClusterAsync(RebootCacheClusterRequest request, AsyncHandler<RebootCacheClusterRequest,CacheCluster> asyncHandler)
AmazonElastiCacheAsync
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.
rebootCacheClusterAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RebootCacheCluster
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request)
AmazonElastiCacheAsync
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.
removeTagsFromResourceAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RemoveTagsFromResource
operation.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
AmazonElastiCacheAsync
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.
removeTagsFromResourceAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RemoveTagsFromResource
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResetCacheParameterGroupResult> resetCacheParameterGroupAsync(ResetCacheParameterGroupRequest request)
AmazonElastiCacheAsync
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.
resetCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ResetCacheParameterGroup
operation.public Future<ResetCacheParameterGroupResult> resetCacheParameterGroupAsync(ResetCacheParameterGroupRequest request, AsyncHandler<ResetCacheParameterGroupRequest,ResetCacheParameterGroupResult> asyncHandler)
AmazonElastiCacheAsync
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.
resetCacheParameterGroupAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a ResetCacheParameterGroup
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CacheSecurityGroup> revokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest request)
AmazonElastiCacheAsync
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngressAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RevokeCacheSecurityGroupIngress
operation.public Future<CacheSecurityGroup> revokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest request, AsyncHandler<RevokeCacheSecurityGroupIngressRequest,CacheSecurityGroup> asyncHandler)
AmazonElastiCacheAsync
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngressAsync
in interface AmazonElastiCacheAsync
request
- Represents the input of a RevokeCacheSecurityGroupIngress
operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> startMigrationAsync(StartMigrationRequest request)
AmazonElastiCacheAsync
Start the migration of data.
startMigrationAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> startMigrationAsync(StartMigrationRequest request, AsyncHandler<StartMigrationRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Start the migration of data.
startMigrationAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> testFailoverAsync(TestFailoverRequest request)
AmazonElastiCacheAsync
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.
testFailoverAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> testFailoverAsync(TestFailoverRequest request, AsyncHandler<TestFailoverRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
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.
testFailoverAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ReplicationGroup> testMigrationAsync(TestMigrationRequest request)
AmazonElastiCacheAsync
Async API to test connection between source and target replication group.
testMigrationAsync
in interface AmazonElastiCacheAsync
public Future<ReplicationGroup> testMigrationAsync(TestMigrationRequest request, AsyncHandler<TestMigrationRequest,ReplicationGroup> asyncHandler)
AmazonElastiCacheAsync
Async API to test connection between source and target replication group.
testMigrationAsync
in interface AmazonElastiCacheAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonElastiCache
shutdown
in class AmazonElastiCacheClient