All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.elasticache.AmazonElastiCacheAsync Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon ElastiCache module holds the client classes that are used for communicating with Amazon ElastiCache Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.elasticache;

import javax.annotation.Generated;

import com.amazonaws.services.elasticache.model.*;

/**
 * Interface for accessing Amazon ElastiCache asynchronously. Each asynchronous method will return a Java Future object
 * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
 * notification when an asynchronous operation completes.
 * 

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.elasticache.AbstractAmazonElastiCacheAsync} instead. *

*

* Amazon ElastiCache *

* 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. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonElastiCacheAsync extends AmazonElastiCache { /** *

* 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. *

* * @param addTagsToResourceRequest * Represents the input of an AddTagsToResource operation. * @return A Java Future containing the result of the AddTagsToResource operation returned by the service. * @sample AmazonElastiCacheAsync.AddTagsToResource * @see AWS * API Documentation */ java.util.concurrent.Future addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest); /** *

* 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. *

* * @param addTagsToResourceRequest * Represents the input of an AddTagsToResource operation. * @param 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. * @return A Java Future containing the result of the AddTagsToResource operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.AddTagsToResource * @see AWS * API Documentation */ java.util.concurrent.Future addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param authorizeCacheSecurityGroupIngressRequest * Represents the input of an AuthorizeCacheSecurityGroupIngress operation. * @return A Java Future containing the result of the AuthorizeCacheSecurityGroupIngress operation returned by the * service. * @sample AmazonElastiCacheAsync.AuthorizeCacheSecurityGroupIngress * @see AWS API Documentation */ java.util.concurrent.Future authorizeCacheSecurityGroupIngressAsync( AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest); /** *

* Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, * and Amazon EC2 security groups are used as the authorization mechanism. *

* *

* You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another * region. *

*
* * @param authorizeCacheSecurityGroupIngressRequest * Represents the input of an AuthorizeCacheSecurityGroupIngress operation. * @param 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. * @return A Java Future containing the result of the AuthorizeCacheSecurityGroupIngress operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.AuthorizeCacheSecurityGroupIngress * @see AWS API Documentation */ java.util.concurrent.Future authorizeCacheSecurityGroupIngressAsync( AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Apply the service update. For more information on service updates and applying them, see Applying Service * Updates. *

* * @param batchApplyUpdateActionRequest * @return A Java Future containing the result of the BatchApplyUpdateAction operation returned by the service. * @sample AmazonElastiCacheAsync.BatchApplyUpdateAction * @see AWS API Documentation */ java.util.concurrent.Future batchApplyUpdateActionAsync(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest); /** *

* Apply the service update. For more information on service updates and applying them, see Applying Service * Updates. *

* * @param batchApplyUpdateActionRequest * @param 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. * @return A Java Future containing the result of the BatchApplyUpdateAction operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.BatchApplyUpdateAction * @see AWS API Documentation */ java.util.concurrent.Future batchApplyUpdateActionAsync(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Stop the service update. For more information on service updates and stopping them, see Stopping * Service Updates. *

* * @param batchStopUpdateActionRequest * @return A Java Future containing the result of the BatchStopUpdateAction operation returned by the service. * @sample AmazonElastiCacheAsync.BatchStopUpdateAction * @see AWS API Documentation */ java.util.concurrent.Future batchStopUpdateActionAsync(BatchStopUpdateActionRequest batchStopUpdateActionRequest); /** *

* Stop the service update. For more information on service updates and stopping them, see Stopping * Service Updates. *

* * @param batchStopUpdateActionRequest * @param 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. * @return A Java Future containing the result of the BatchStopUpdateAction operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.BatchStopUpdateAction * @see AWS API Documentation */ java.util.concurrent.Future batchStopUpdateActionAsync(BatchStopUpdateActionRequest batchStopUpdateActionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Complete the migration of data. *

* * @param completeMigrationRequest * @return A Java Future containing the result of the CompleteMigration operation returned by the service. * @sample AmazonElastiCacheAsync.CompleteMigration * @see AWS * API Documentation */ java.util.concurrent.Future completeMigrationAsync(CompleteMigrationRequest completeMigrationRequest); /** *

* Complete the migration of data. *

* * @param completeMigrationRequest * @param 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. * @return A Java Future containing the result of the CompleteMigration operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CompleteMigration * @see AWS * API Documentation */ java.util.concurrent.Future completeMigrationAsync(CompleteMigrationRequest completeMigrationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only. *

* * @param copyServerlessCacheSnapshotRequest * @return A Java Future containing the result of the CopyServerlessCacheSnapshot operation returned by the service. * @sample AmazonElastiCacheAsync.CopyServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future copyServerlessCacheSnapshotAsync( CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest); /** *

* Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only. *

* * @param copyServerlessCacheSnapshotRequest * @param 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. * @return A Java Future containing the result of the CopyServerlessCacheSnapshot operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CopyServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future copyServerlessCacheSnapshotAsync( CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

    *
  • *
* * @param copySnapshotRequest * Represents the input of a CopySnapshotMessage operation. * @return A Java Future containing the result of the CopySnapshot operation returned by the service. * @sample AmazonElastiCacheAsync.CopySnapshot * @see AWS API * Documentation */ java.util.concurrent.Future copySnapshotAsync(CopySnapshotRequest copySnapshotRequest); /** *

* 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. *

    *
  • *
* * @param copySnapshotRequest * Represents the input of a CopySnapshotMessage operation. * @param 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. * @return A Java Future containing the result of the CopySnapshot operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CopySnapshot * @see AWS API * Documentation */ java.util.concurrent.Future copySnapshotAsync(CopySnapshotRequest copySnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param createCacheClusterRequest * Represents the input of a CreateCacheCluster operation. * @return A Java Future containing the result of the CreateCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsync.CreateCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future createCacheClusterAsync(CreateCacheClusterRequest createCacheClusterRequest); /** *

* 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. *

* * @param createCacheClusterRequest * Represents the input of a CreateCacheCluster operation. * @param 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. * @return A Java Future containing the result of the CreateCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future createCacheClusterAsync(CreateCacheClusterRequest createCacheClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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: *

* * * @param createCacheParameterGroupRequest * Represents the input of a CreateCacheParameterGroup operation. * @return A Java Future containing the result of the CreateCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsync.CreateCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheParameterGroupAsync(CreateCacheParameterGroupRequest createCacheParameterGroupRequest); /** *

* 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: *

* * * @param createCacheParameterGroupRequest * Represents the input of a CreateCacheParameterGroup operation. * @param 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. * @return A Java Future containing the result of the CreateCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheParameterGroupAsync(CreateCacheParameterGroupRequest createCacheParameterGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param createCacheSecurityGroupRequest * Represents the input of a CreateCacheSecurityGroup operation. * @return A Java Future containing the result of the CreateCacheSecurityGroup operation returned by the service. * @sample AmazonElastiCacheAsync.CreateCacheSecurityGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest); /** *

* 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. *

* * @param createCacheSecurityGroupRequest * Represents the input of a CreateCacheSecurityGroup operation. * @param 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. * @return A Java Future containing the result of the CreateCacheSecurityGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateCacheSecurityGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a new cache subnet group. *

*

* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). *

* * @param createCacheSubnetGroupRequest * Represents the input of a CreateCacheSubnetGroup operation. * @return A Java Future containing the result of the CreateCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsync.CreateCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest); /** *

* Creates a new cache subnet group. *

*

* Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). *

* * @param createCacheSubnetGroupRequest * Represents the input of a CreateCacheSubnetGroup operation. * @param 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. * @return A Java Future containing the result of the CreateCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future createCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

    *
  • *
* * @param createGlobalReplicationGroupRequest * @return A Java Future containing the result of the CreateGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsync.CreateGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future createGlobalReplicationGroupAsync( CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest); /** *

* 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. *

    *
  • *
* * @param createGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the CreateGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.CreateGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future createGlobalReplicationGroupAsync( CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param createReplicationGroupRequest * Represents the input of a CreateReplicationGroup operation. * @return A Java Future containing the result of the CreateReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsync.CreateReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future createReplicationGroupAsync(CreateReplicationGroupRequest createReplicationGroupRequest); /** *

* 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. *

*
* * @param createReplicationGroupRequest * Represents the input of a CreateReplicationGroup operation. * @param 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. * @return A Java Future containing the result of the CreateReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future createReplicationGroupAsync(CreateReplicationGroupRequest createReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a serverless cache. *

* * @param createServerlessCacheRequest * @return A Java Future containing the result of the CreateServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsync.CreateServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future createServerlessCacheAsync(CreateServerlessCacheRequest createServerlessCacheRequest); /** *

* Creates a serverless cache. *

* * @param createServerlessCacheRequest * @param 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. * @return A Java Future containing the result of the CreateServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future createServerlessCacheAsync(CreateServerlessCacheRequest createServerlessCacheRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and * Serverless Memcached only. *

* * @param createServerlessCacheSnapshotRequest * @return A Java Future containing the result of the CreateServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsync.CreateServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future createServerlessCacheSnapshotAsync( CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest); /** *

* This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and * Serverless Memcached only. *

* * @param createServerlessCacheSnapshotRequest * @param 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. * @return A Java Future containing the result of the CreateServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.CreateServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future createServerlessCacheSnapshotAsync( CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a copy of an entire cluster or replication group at a specific moment in time. *

* *

* This operation is valid for Redis OSS only. *

*
* * @param createSnapshotRequest * Represents the input of a CreateSnapshot operation. * @return A Java Future containing the result of the CreateSnapshot operation returned by the service. * @sample AmazonElastiCacheAsync.CreateSnapshot * @see AWS API * Documentation */ java.util.concurrent.Future createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest); /** *

* Creates a copy of an entire cluster or replication group at a specific moment in time. *

* *

* This operation is valid for Redis OSS only. *

*
* * @param createSnapshotRequest * Represents the input of a CreateSnapshot operation. * @param 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. * @return A Java Future containing the result of the CreateSnapshot operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateSnapshot * @see AWS API * Documentation */ java.util.concurrent.Future createSnapshotAsync(CreateSnapshotRequest createSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access * Control (RBAC). *

* * @param createUserRequest * @return A Java Future containing the result of the CreateUser operation returned by the service. * @sample AmazonElastiCacheAsync.CreateUser * @see AWS API * Documentation */ java.util.concurrent.Future createUserAsync(CreateUserRequest createUserRequest); /** *

* For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access * Control (RBAC). *

* * @param createUserRequest * @param 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. * @return A Java Future containing the result of the CreateUser operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateUser * @see AWS API * Documentation */ java.util.concurrent.Future createUserAsync(CreateUserRequest createUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access * Control (RBAC) *

* * @param createUserGroupRequest * @return A Java Future containing the result of the CreateUserGroup operation returned by the service. * @sample AmazonElastiCacheAsync.CreateUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future createUserGroupAsync(CreateUserGroupRequest createUserGroupRequest); /** *

* For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access * Control (RBAC) *

* * @param createUserGroupRequest * @param 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. * @return A Java Future containing the result of the CreateUserGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.CreateUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future createUserGroupAsync(CreateUserGroupRequest createUserGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Decreases the number of node groups in a Global datastore *

* * @param decreaseNodeGroupsInGlobalReplicationGroupRequest * @return A Java Future containing the result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned * by the service. * @sample AmazonElastiCacheAsync.DecreaseNodeGroupsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future decreaseNodeGroupsInGlobalReplicationGroupAsync( DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest); /** *

* Decreases the number of node groups in a Global datastore *

* * @param decreaseNodeGroupsInGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned * by the service. * @sample AmazonElastiCacheAsyncHandler.DecreaseNodeGroupsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future decreaseNodeGroupsInGlobalReplicationGroupAsync( DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param decreaseReplicaCountRequest * @return A Java Future containing the result of the DecreaseReplicaCount operation returned by the service. * @sample AmazonElastiCacheAsync.DecreaseReplicaCount * @see AWS API Documentation */ java.util.concurrent.Future decreaseReplicaCountAsync(DecreaseReplicaCountRequest decreaseReplicaCountRequest); /** *

* 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. *

* * @param decreaseReplicaCountRequest * @param 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. * @return A Java Future containing the result of the DecreaseReplicaCount operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DecreaseReplicaCount * @see AWS API Documentation */ java.util.concurrent.Future decreaseReplicaCountAsync(DecreaseReplicaCountRequest decreaseReplicaCountRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 *

    *
  • *
* * @param deleteCacheClusterRequest * Represents the input of a DeleteCacheCluster operation. * @return A Java Future containing the result of the DeleteCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future deleteCacheClusterAsync(DeleteCacheClusterRequest deleteCacheClusterRequest); /** *

* 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 *

    *
  • *
* * @param deleteCacheClusterRequest * Represents the input of a DeleteCacheCluster operation. * @param 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. * @return A Java Future containing the result of the DeleteCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future deleteCacheClusterAsync(DeleteCacheClusterRequest deleteCacheClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteCacheParameterGroupRequest * Represents the input of a DeleteCacheParameterGroup operation. * @return A Java Future containing the result of the DeleteCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheParameterGroupAsync( DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest); /** *

* 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. *

* * @param deleteCacheParameterGroupRequest * Represents the input of a DeleteCacheParameterGroup operation. * @param 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. * @return A Java Future containing the result of the DeleteCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheParameterGroupAsync( DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes a cache security group. *

* *

* You cannot delete a cache security group if it is associated with any clusters. *

*
* * @param deleteCacheSecurityGroupRequest * Represents the input of a DeleteCacheSecurityGroup operation. * @return A Java Future containing the result of the DeleteCacheSecurityGroup operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteCacheSecurityGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest); /** *

* Deletes a cache security group. *

* *

* You cannot delete a cache security group if it is associated with any clusters. *

*
* * @param deleteCacheSecurityGroupRequest * Represents the input of a DeleteCacheSecurityGroup operation. * @param 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. * @return A Java Future containing the result of the DeleteCacheSecurityGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteCacheSecurityGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes a cache subnet group. *

* *

* You cannot delete a default cache subnet group or one that is associated with any clusters. *

*
* * @param deleteCacheSubnetGroupRequest * Represents the input of a DeleteCacheSubnetGroup operation. * @return A Java Future containing the result of the DeleteCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest); /** *

* Deletes a cache subnet group. *

* *

* You cannot delete a default cache subnet group or one that is associated with any clusters. *

*
* * @param deleteCacheSubnetGroupRequest * Represents the input of a DeleteCacheSubnetGroup operation. * @param 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. * @return A Java Future containing the result of the DeleteCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteGlobalReplicationGroupRequest * @return A Java Future containing the result of the DeleteGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsync.DeleteGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteGlobalReplicationGroupAsync( DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest); /** *

* 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. *

* * @param deleteGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the DeleteGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DeleteGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteGlobalReplicationGroupAsync( DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

    *
  • *
*
* * @param deleteReplicationGroupRequest * Represents the input of a DeleteReplicationGroup operation. * @return A Java Future containing the result of the DeleteReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteReplicationGroupAsync(DeleteReplicationGroupRequest deleteReplicationGroupRequest); /** *

* Deletes an existing replication group. By default, this operation deletes the entire replication group, including * the primary/primaries and all of the read replicas. If the replication group has only one primary, you can * optionally delete only the read replicas, while retaining the primary by setting * RetainPrimaryCluster=true. *

*

* When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the * selected resources; you cannot cancel or revert this operation. *

* *
    *
  • *

    * 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. *

    *
  • *
*
* * @param deleteReplicationGroupRequest * Represents the input of a DeleteReplicationGroup operation. * @param 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. * @return A Java Future containing the result of the DeleteReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future deleteReplicationGroupAsync(DeleteReplicationGroupRequest deleteReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param deleteServerlessCacheRequest * @return A Java Future containing the result of the DeleteServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future deleteServerlessCacheAsync(DeleteServerlessCacheRequest deleteServerlessCacheRequest); /** *

* 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. *

*
* * @param deleteServerlessCacheRequest * @param 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. * @return A Java Future containing the result of the DeleteServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future deleteServerlessCacheAsync(DeleteServerlessCacheRequest deleteServerlessCacheRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only. *

* * @param deleteServerlessCacheSnapshotRequest * @return A Java Future containing the result of the DeleteServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsync.DeleteServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future deleteServerlessCacheSnapshotAsync( DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest); /** *

* Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only. *

* * @param deleteServerlessCacheSnapshotRequest * @param 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. * @return A Java Future containing the result of the DeleteServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DeleteServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future deleteServerlessCacheSnapshotAsync( DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param deleteSnapshotRequest * Represents the input of a DeleteSnapshot operation. * @return A Java Future containing the result of the DeleteSnapshot operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteSnapshot * @see AWS API * Documentation */ java.util.concurrent.Future deleteSnapshotAsync(DeleteSnapshotRequest deleteSnapshotRequest); /** *

* Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately * begins deleting the snapshot; you cannot cancel or revert this operation. *

* *

* This operation is valid for Redis OSS only. *

*
* * @param deleteSnapshotRequest * Represents the input of a DeleteSnapshot operation. * @param 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. * @return A Java Future containing the result of the DeleteSnapshot operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteSnapshot * @see AWS API * Documentation */ java.util.concurrent.Future deleteSnapshotAsync(DeleteSnapshotRequest deleteSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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). *

* * @param deleteUserRequest * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future deleteUserAsync(DeleteUserRequest deleteUserRequest); /** *

* 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). *

* * @param deleteUserRequest * @param 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. * @return A Java Future containing the result of the DeleteUser operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteUser * @see AWS API * Documentation */ java.util.concurrent.Future deleteUserAsync(DeleteUserRequest deleteUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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). *

* * @param deleteUserGroupRequest * @return A Java Future containing the result of the DeleteUserGroup operation returned by the service. * @sample AmazonElastiCacheAsync.DeleteUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future deleteUserGroupAsync(DeleteUserGroupRequest deleteUserGroupRequest); /** *

* 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). *

* * @param deleteUserGroupRequest * @param 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. * @return A Java Future containing the result of the DeleteUserGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DeleteUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future deleteUserGroupAsync(DeleteUserGroupRequest deleteUserGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeCacheClustersRequest * Represents the input of a DescribeCacheClusters operation. * @return A Java Future containing the result of the DescribeCacheClusters operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeCacheClusters * @see AWS API Documentation */ java.util.concurrent.Future describeCacheClustersAsync(DescribeCacheClustersRequest describeCacheClustersRequest); /** *

* 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. *

* * @param describeCacheClustersRequest * Represents the input of a DescribeCacheClusters operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheClusters operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheClusters * @see AWS API Documentation */ java.util.concurrent.Future describeCacheClustersAsync(DescribeCacheClustersRequest describeCacheClustersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeCacheClusters operation. * * @see #describeCacheClustersAsync(DescribeCacheClustersRequest) */ java.util.concurrent.Future describeCacheClustersAsync(); /** * Simplified method form for invoking the DescribeCacheClusters operation with an AsyncHandler. * * @see #describeCacheClustersAsync(DescribeCacheClustersRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeCacheClustersAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns a list of the available cache engines and their versions. *

* * @param describeCacheEngineVersionsRequest * Represents the input of a DescribeCacheEngineVersions operation. * @return A Java Future containing the result of the DescribeCacheEngineVersions operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeCacheEngineVersions * @see AWS API Documentation */ java.util.concurrent.Future describeCacheEngineVersionsAsync( DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest); /** *

* Returns a list of the available cache engines and their versions. *

* * @param describeCacheEngineVersionsRequest * Represents the input of a DescribeCacheEngineVersions operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheEngineVersions operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheEngineVersions * @see AWS API Documentation */ java.util.concurrent.Future describeCacheEngineVersionsAsync( DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeCacheEngineVersions operation. * * @see #describeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest) */ java.util.concurrent.Future describeCacheEngineVersionsAsync(); /** * Simplified method form for invoking the DescribeCacheEngineVersions operation with an AsyncHandler. * * @see #describeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeCacheEngineVersionsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeCacheParameterGroupsRequest * Represents the input of a DescribeCacheParameterGroups operation. * @return A Java Future containing the result of the DescribeCacheParameterGroups operation returned by the * service. * @sample AmazonElastiCacheAsync.DescribeCacheParameterGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheParameterGroupsAsync( DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest); /** *

* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list * contains only the descriptions for that group. *

* * @param describeCacheParameterGroupsRequest * Represents the input of a DescribeCacheParameterGroups operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheParameterGroups operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheParameterGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheParameterGroupsAsync( DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeCacheParameterGroups operation. * * @see #describeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest) */ java.util.concurrent.Future describeCacheParameterGroupsAsync(); /** * Simplified method form for invoking the DescribeCacheParameterGroups operation with an AsyncHandler. * * @see #describeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeCacheParameterGroupsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the detailed parameter list for a particular cache parameter group. *

* * @param describeCacheParametersRequest * Represents the input of a DescribeCacheParameters operation. * @return A Java Future containing the result of the DescribeCacheParameters operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeCacheParameters * @see AWS API Documentation */ java.util.concurrent.Future describeCacheParametersAsync(DescribeCacheParametersRequest describeCacheParametersRequest); /** *

* Returns the detailed parameter list for a particular cache parameter group. *

* * @param describeCacheParametersRequest * Represents the input of a DescribeCacheParameters operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheParameters operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheParameters * @see AWS API Documentation */ java.util.concurrent.Future describeCacheParametersAsync(DescribeCacheParametersRequest describeCacheParametersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 *

* * @param describeCacheSecurityGroupsRequest * Represents the input of a DescribeCacheSecurityGroups operation. * @return A Java Future containing the result of the DescribeCacheSecurityGroups operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeCacheSecurityGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheSecurityGroupsAsync( DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest); /** *

* Returns a list of cache security group descriptions. If a cache security group name is specified, the list * contains only the description of that group. This applicable only when you have ElastiCache in Classic setup *

* * @param describeCacheSecurityGroupsRequest * Represents the input of a DescribeCacheSecurityGroups operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheSecurityGroups operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheSecurityGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheSecurityGroupsAsync( DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeCacheSecurityGroups operation. * * @see #describeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest) */ java.util.concurrent.Future describeCacheSecurityGroupsAsync(); /** * Simplified method form for invoking the DescribeCacheSecurityGroups operation with an AsyncHandler. * * @see #describeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeCacheSecurityGroupsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeCacheSubnetGroupsRequest * Represents the input of a DescribeCacheSubnetGroups operation. * @return A Java Future containing the result of the DescribeCacheSubnetGroups operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeCacheSubnetGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheSubnetGroupsAsync( DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest); /** *

* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only * the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache * clusters now launch in VPC by default. *

* * @param describeCacheSubnetGroupsRequest * Represents the input of a DescribeCacheSubnetGroups operation. * @param 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. * @return A Java Future containing the result of the DescribeCacheSubnetGroups operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeCacheSubnetGroups * @see AWS API Documentation */ java.util.concurrent.Future describeCacheSubnetGroupsAsync( DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeCacheSubnetGroups operation. * * @see #describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest) */ java.util.concurrent.Future describeCacheSubnetGroupsAsync(); /** * Simplified method form for invoking the DescribeCacheSubnetGroups operation with an AsyncHandler. * * @see #describeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeCacheSubnetGroupsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the default engine and system parameter information for the specified cache engine. *

* * @param describeEngineDefaultParametersRequest * Represents the input of a DescribeEngineDefaultParameters operation. * @return A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the * service. * @sample AmazonElastiCacheAsync.DescribeEngineDefaultParameters * @see AWS API Documentation */ java.util.concurrent.Future describeEngineDefaultParametersAsync( DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest); /** *

* Returns the default engine and system parameter information for the specified cache engine. *

* * @param describeEngineDefaultParametersRequest * Represents the input of a DescribeEngineDefaultParameters operation. * @param 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. * @return A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DescribeEngineDefaultParameters * @see AWS API Documentation */ java.util.concurrent.Future describeEngineDefaultParametersAsync( DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeEventsRequest * Represents the input of a DescribeEvents operation. * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future describeEventsAsync(DescribeEventsRequest describeEventsRequest); /** *

* 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. *

* * @param describeEventsRequest * Represents the input of a DescribeEvents operation. * @param 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. * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future describeEventsAsync(DescribeEventsRequest describeEventsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeEvents operation. * * @see #describeEventsAsync(DescribeEventsRequest) */ java.util.concurrent.Future describeEventsAsync(); /** * Simplified method form for invoking the DescribeEvents operation with an AsyncHandler. * * @see #describeEventsAsync(DescribeEventsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeEventsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns information about a particular global replication group. If no identifier is specified, returns * information about all Global datastores. *

* * @param describeGlobalReplicationGroupsRequest * @return A Java Future containing the result of the DescribeGlobalReplicationGroups operation returned by the * service. * @sample AmazonElastiCacheAsync.DescribeGlobalReplicationGroups * @see AWS API Documentation */ java.util.concurrent.Future describeGlobalReplicationGroupsAsync( DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest); /** *

* Returns information about a particular global replication group. If no identifier is specified, returns * information about all Global datastores. *

* * @param describeGlobalReplicationGroupsRequest * @param 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. * @return A Java Future containing the result of the DescribeGlobalReplicationGroups operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DescribeGlobalReplicationGroups * @see AWS API Documentation */ java.util.concurrent.Future describeGlobalReplicationGroupsAsync( DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param describeReplicationGroupsRequest * Represents the input of a DescribeReplicationGroups operation. * @return A Java Future containing the result of the DescribeReplicationGroups operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeReplicationGroups * @see AWS API Documentation */ java.util.concurrent.Future describeReplicationGroupsAsync( DescribeReplicationGroupsRequest describeReplicationGroupsRequest); /** *

* Returns information about a particular replication group. If no identifier is specified, * DescribeReplicationGroups returns information about all replication groups. *

* *

* This operation is valid for Redis OSS only. *

*
* * @param describeReplicationGroupsRequest * Represents the input of a DescribeReplicationGroups operation. * @param 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. * @return A Java Future containing the result of the DescribeReplicationGroups operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeReplicationGroups * @see AWS API Documentation */ java.util.concurrent.Future describeReplicationGroupsAsync( DescribeReplicationGroupsRequest describeReplicationGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeReplicationGroups operation. * * @see #describeReplicationGroupsAsync(DescribeReplicationGroupsRequest) */ java.util.concurrent.Future describeReplicationGroupsAsync(); /** * Simplified method form for invoking the DescribeReplicationGroups operation with an AsyncHandler. * * @see #describeReplicationGroupsAsync(DescribeReplicationGroupsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeReplicationGroupsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns information about reserved cache nodes for this account, or about a specified reserved cache node. *

* * @param describeReservedCacheNodesRequest * Represents the input of a DescribeReservedCacheNodes operation. * @return A Java Future containing the result of the DescribeReservedCacheNodes operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeReservedCacheNodes * @see AWS API Documentation */ java.util.concurrent.Future describeReservedCacheNodesAsync( DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest); /** *

* Returns information about reserved cache nodes for this account, or about a specified reserved cache node. *

* * @param describeReservedCacheNodesRequest * Represents the input of a DescribeReservedCacheNodes operation. * @param 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. * @return A Java Future containing the result of the DescribeReservedCacheNodes operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeReservedCacheNodes * @see AWS API Documentation */ java.util.concurrent.Future describeReservedCacheNodesAsync( DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeReservedCacheNodes operation. * * @see #describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest) */ java.util.concurrent.Future describeReservedCacheNodesAsync(); /** * Simplified method form for invoking the DescribeReservedCacheNodes operation with an AsyncHandler. * * @see #describeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeReservedCacheNodesAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists available reserved cache node offerings. *

* * @param describeReservedCacheNodesOfferingsRequest * Represents the input of a DescribeReservedCacheNodesOfferings operation. * @return A Java Future containing the result of the DescribeReservedCacheNodesOfferings operation returned by the * service. * @sample AmazonElastiCacheAsync.DescribeReservedCacheNodesOfferings * @see AWS API Documentation */ java.util.concurrent.Future describeReservedCacheNodesOfferingsAsync( DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest); /** *

* Lists available reserved cache node offerings. *

* * @param describeReservedCacheNodesOfferingsRequest * Represents the input of a DescribeReservedCacheNodesOfferings operation. * @param 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. * @return A Java Future containing the result of the DescribeReservedCacheNodesOfferings operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DescribeReservedCacheNodesOfferings * @see AWS API Documentation */ java.util.concurrent.Future describeReservedCacheNodesOfferingsAsync( DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation. * * @see #describeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest) */ java.util.concurrent.Future describeReservedCacheNodesOfferingsAsync(); /** * Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation with an AsyncHandler. * * @see #describeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest, * com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeReservedCacheNodesOfferingsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeServerlessCacheSnapshotsRequest * @return A Java Future containing the result of the DescribeServerlessCacheSnapshots operation returned by the * service. * @sample AmazonElastiCacheAsync.DescribeServerlessCacheSnapshots * @see AWS API Documentation */ java.util.concurrent.Future describeServerlessCacheSnapshotsAsync( DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest); /** *

* 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. *

* * @param describeServerlessCacheSnapshotsRequest * @param 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. * @return A Java Future containing the result of the DescribeServerlessCacheSnapshots operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DescribeServerlessCacheSnapshots * @see AWS API Documentation */ java.util.concurrent.Future describeServerlessCacheSnapshotsAsync( DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeServerlessCachesRequest * @return A Java Future containing the result of the DescribeServerlessCaches operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeServerlessCaches * @see AWS API Documentation */ java.util.concurrent.Future describeServerlessCachesAsync(DescribeServerlessCachesRequest describeServerlessCachesRequest); /** *

* 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. *

* * @param describeServerlessCachesRequest * @param 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. * @return A Java Future containing the result of the DescribeServerlessCaches operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeServerlessCaches * @see AWS API Documentation */ java.util.concurrent.Future describeServerlessCachesAsync(DescribeServerlessCachesRequest describeServerlessCachesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns details of the service updates *

* * @param describeServiceUpdatesRequest * @return A Java Future containing the result of the DescribeServiceUpdates operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeServiceUpdates * @see AWS API Documentation */ java.util.concurrent.Future describeServiceUpdatesAsync(DescribeServiceUpdatesRequest describeServiceUpdatesRequest); /** *

* Returns details of the service updates *

* * @param describeServiceUpdatesRequest * @param 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. * @return A Java Future containing the result of the DescribeServiceUpdates operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeServiceUpdates * @see AWS API Documentation */ java.util.concurrent.Future describeServiceUpdatesAsync(DescribeServiceUpdatesRequest describeServiceUpdatesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

*
* * @param describeSnapshotsRequest * Represents the input of a DescribeSnapshotsMessage operation. * @return A Java Future containing the result of the DescribeSnapshots operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeSnapshots * @see AWS * API Documentation */ java.util.concurrent.Future describeSnapshotsAsync(DescribeSnapshotsRequest describeSnapshotsRequest); /** *

* 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. *

*
* * @param describeSnapshotsRequest * Represents the input of a DescribeSnapshotsMessage operation. * @param 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. * @return A Java Future containing the result of the DescribeSnapshots operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeSnapshots * @see AWS * API Documentation */ java.util.concurrent.Future describeSnapshotsAsync(DescribeSnapshotsRequest describeSnapshotsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the DescribeSnapshots operation. * * @see #describeSnapshotsAsync(DescribeSnapshotsRequest) */ java.util.concurrent.Future describeSnapshotsAsync(); /** * Simplified method form for invoking the DescribeSnapshots operation with an AsyncHandler. * * @see #describeSnapshotsAsync(DescribeSnapshotsRequest, com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future describeSnapshotsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns details of the update actions *

* * @param describeUpdateActionsRequest * @return A Java Future containing the result of the DescribeUpdateActions operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeUpdateActions * @see AWS API Documentation */ java.util.concurrent.Future describeUpdateActionsAsync(DescribeUpdateActionsRequest describeUpdateActionsRequest); /** *

* Returns details of the update actions *

* * @param describeUpdateActionsRequest * @param 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. * @return A Java Future containing the result of the DescribeUpdateActions operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeUpdateActions * @see AWS API Documentation */ java.util.concurrent.Future describeUpdateActionsAsync(DescribeUpdateActionsRequest describeUpdateActionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns a list of user groups. *

* * @param describeUserGroupsRequest * @return A Java Future containing the result of the DescribeUserGroups operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeUserGroups * @see AWS * API Documentation */ java.util.concurrent.Future describeUserGroupsAsync(DescribeUserGroupsRequest describeUserGroupsRequest); /** *

* Returns a list of user groups. *

* * @param describeUserGroupsRequest * @param 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. * @return A Java Future containing the result of the DescribeUserGroups operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeUserGroups * @see AWS * API Documentation */ java.util.concurrent.Future describeUserGroupsAsync(DescribeUserGroupsRequest describeUserGroupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns a list of users. *

* * @param describeUsersRequest * @return A Java Future containing the result of the DescribeUsers operation returned by the service. * @sample AmazonElastiCacheAsync.DescribeUsers * @see AWS API * Documentation */ java.util.concurrent.Future describeUsersAsync(DescribeUsersRequest describeUsersRequest); /** *

* Returns a list of users. *

* * @param describeUsersRequest * @param 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. * @return A Java Future containing the result of the DescribeUsers operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.DescribeUsers * @see AWS API * Documentation */ java.util.concurrent.Future describeUsersAsync(DescribeUsersRequest describeUsersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param disassociateGlobalReplicationGroupRequest * @return A Java Future containing the result of the DisassociateGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsync.DisassociateGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future disassociateGlobalReplicationGroupAsync( DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest); /** *

* 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. *

* * @param disassociateGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the DisassociateGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.DisassociateGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future disassociateGlobalReplicationGroupAsync( DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS * only. *

* * @param exportServerlessCacheSnapshotRequest * @return A Java Future containing the result of the ExportServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsync.ExportServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future exportServerlessCacheSnapshotAsync( ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest); /** *

* Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS * only. *

* * @param exportServerlessCacheSnapshotRequest * @param 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. * @return A Java Future containing the result of the ExportServerlessCacheSnapshot operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.ExportServerlessCacheSnapshot * @see AWS API Documentation */ java.util.concurrent.Future exportServerlessCacheSnapshotAsync( ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Used to failover the primary region to a secondary region. The secondary region will become primary, and all * other clusters will become secondary. *

* * @param failoverGlobalReplicationGroupRequest * @return A Java Future containing the result of the FailoverGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsync.FailoverGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future failoverGlobalReplicationGroupAsync( FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest); /** *

* Used to failover the primary region to a secondary region. The secondary region will become primary, and all * other clusters will become secondary. *

* * @param failoverGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the FailoverGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.FailoverGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future failoverGlobalReplicationGroupAsync( FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Increase the number of node groups in the Global datastore *

* * @param increaseNodeGroupsInGlobalReplicationGroupRequest * @return A Java Future containing the result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned * by the service. * @sample AmazonElastiCacheAsync.IncreaseNodeGroupsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future increaseNodeGroupsInGlobalReplicationGroupAsync( IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest); /** *

* Increase the number of node groups in the Global datastore *

* * @param increaseNodeGroupsInGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned * by the service. * @sample AmazonElastiCacheAsyncHandler.IncreaseNodeGroupsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future increaseNodeGroupsInGlobalReplicationGroupAsync( IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param increaseReplicaCountRequest * @return A Java Future containing the result of the IncreaseReplicaCount operation returned by the service. * @sample AmazonElastiCacheAsync.IncreaseReplicaCount * @see AWS API Documentation */ java.util.concurrent.Future increaseReplicaCountAsync(IncreaseReplicaCountRequest increaseReplicaCountRequest); /** *

* 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. *

* * @param increaseReplicaCountRequest * @param 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. * @return A Java Future containing the result of the IncreaseReplicaCount operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.IncreaseReplicaCount * @see AWS API Documentation */ java.util.concurrent.Future increaseReplicaCountAsync(IncreaseReplicaCountRequest increaseReplicaCountRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param listAllowedNodeTypeModificationsRequest * The input parameters for the ListAllowedNodeTypeModifications operation. * @return A Java Future containing the result of the ListAllowedNodeTypeModifications operation returned by the * service. * @sample AmazonElastiCacheAsync.ListAllowedNodeTypeModifications * @see AWS API Documentation */ java.util.concurrent.Future listAllowedNodeTypeModificationsAsync( ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest); /** *

* 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. *

* * @param listAllowedNodeTypeModificationsRequest * The input parameters for the ListAllowedNodeTypeModifications operation. * @param 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. * @return A Java Future containing the result of the ListAllowedNodeTypeModifications operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.ListAllowedNodeTypeModifications * @see AWS API Documentation */ java.util.concurrent.Future listAllowedNodeTypeModificationsAsync( ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** * Simplified method form for invoking the ListAllowedNodeTypeModifications operation. * * @see #listAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest) */ java.util.concurrent.Future listAllowedNodeTypeModificationsAsync(); /** * Simplified method form for invoking the ListAllowedNodeTypeModifications operation with an AsyncHandler. * * @see #listAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest, * com.amazonaws.handlers.AsyncHandler) */ java.util.concurrent.Future listAllowedNodeTypeModificationsAsync( com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param listTagsForResourceRequest * The input parameters for the ListTagsForResource operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonElastiCacheAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* 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. *

* * @param listTagsForResourceRequest * The input parameters for the ListTagsForResource operation. * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param modifyCacheClusterRequest * Represents the input of a ModifyCacheCluster operation. * @return A Java Future containing the result of the ModifyCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future modifyCacheClusterAsync(ModifyCacheClusterRequest modifyCacheClusterRequest); /** *

* 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. *

* * @param modifyCacheClusterRequest * Represents the input of a ModifyCacheCluster operation. * @param 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. * @return A Java Future containing the result of the ModifyCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future modifyCacheClusterAsync(ModifyCacheClusterRequest modifyCacheClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param modifyCacheParameterGroupRequest * Represents the input of a ModifyCacheParameterGroup operation. * @return A Java Future containing the result of the ModifyCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyCacheParameterGroupAsync( ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest); /** *

* Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by * submitting a list parameter name and value pairs. *

* * @param modifyCacheParameterGroupRequest * Represents the input of a ModifyCacheParameterGroup operation. * @param 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. * @return A Java Future containing the result of the ModifyCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyCacheParameterGroupAsync( ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies an existing cache subnet group. *

* * @param modifyCacheSubnetGroupRequest * Represents the input of a ModifyCacheSubnetGroup operation. * @return A Java Future containing the result of the ModifyCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest); /** *

* Modifies an existing cache subnet group. *

* * @param modifyCacheSubnetGroupRequest * Represents the input of a ModifyCacheSubnetGroup operation. * @param 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. * @return A Java Future containing the result of the ModifyCacheSubnetGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyCacheSubnetGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies the settings for a Global datastore. *

* * @param modifyGlobalReplicationGroupRequest * @return A Java Future containing the result of the ModifyGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsync.ModifyGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyGlobalReplicationGroupAsync( ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest); /** *

* Modifies the settings for a Global datastore. *

* * @param modifyGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the ModifyGlobalReplicationGroup operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.ModifyGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyGlobalReplicationGroupAsync( ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer. *

* * *

* This operation is valid for Redis OSS only. *

*
* * @param modifyReplicationGroupRequest * Represents the input of a ModifyReplicationGroups operation. * @return A Java Future containing the result of the ModifyReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyReplicationGroupAsync(ModifyReplicationGroupRequest modifyReplicationGroupRequest); /** *

* Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer. *

* * *

* This operation is valid for Redis OSS only. *

*
* * @param modifyReplicationGroupRequest * Represents the input of a ModifyReplicationGroups operation. * @param 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. * @return A Java Future containing the result of the ModifyReplicationGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future modifyReplicationGroupAsync(ModifyReplicationGroupRequest modifyReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance * the keyspaces among existing shards. *

* * @param modifyReplicationGroupShardConfigurationRequest * Represents the input for a ModifyReplicationGroupShardConfiguration operation. * @return A Java Future containing the result of the ModifyReplicationGroupShardConfiguration operation returned by * the service. * @sample AmazonElastiCacheAsync.ModifyReplicationGroupShardConfiguration * @see AWS API Documentation */ java.util.concurrent.Future modifyReplicationGroupShardConfigurationAsync( ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest); /** *

* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance * the keyspaces among existing shards. *

* * @param modifyReplicationGroupShardConfigurationRequest * Represents the input for a ModifyReplicationGroupShardConfiguration operation. * @param 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. * @return A Java Future containing the result of the ModifyReplicationGroupShardConfiguration operation returned by * the service. * @sample AmazonElastiCacheAsyncHandler.ModifyReplicationGroupShardConfiguration * @see AWS API Documentation */ java.util.concurrent.Future modifyReplicationGroupShardConfigurationAsync( ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* This API modifies the attributes of a serverless cache. *

* * @param modifyServerlessCacheRequest * @return A Java Future containing the result of the ModifyServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future modifyServerlessCacheAsync(ModifyServerlessCacheRequest modifyServerlessCacheRequest); /** *

* This API modifies the attributes of a serverless cache. *

* * @param modifyServerlessCacheRequest * @param 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. * @return A Java Future containing the result of the ModifyServerlessCache operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyServerlessCache * @see AWS API Documentation */ java.util.concurrent.Future modifyServerlessCacheAsync(ModifyServerlessCacheRequest modifyServerlessCacheRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Changes user password(s) and/or access string. *

* * @param modifyUserRequest * @return A Java Future containing the result of the ModifyUser operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyUser * @see AWS API * Documentation */ java.util.concurrent.Future modifyUserAsync(ModifyUserRequest modifyUserRequest); /** *

* Changes user password(s) and/or access string. *

* * @param modifyUserRequest * @param 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. * @return A Java Future containing the result of the ModifyUser operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyUser * @see AWS API * Documentation */ java.util.concurrent.Future modifyUserAsync(ModifyUserRequest modifyUserRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Changes the list of users that belong to the user group. *

* * @param modifyUserGroupRequest * @return A Java Future containing the result of the ModifyUserGroup operation returned by the service. * @sample AmazonElastiCacheAsync.ModifyUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future modifyUserGroupAsync(ModifyUserGroupRequest modifyUserGroupRequest); /** *

* Changes the list of users that belong to the user group. *

* * @param modifyUserGroupRequest * @param 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. * @return A Java Future containing the result of the ModifyUserGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ModifyUserGroup * @see AWS * API Documentation */ java.util.concurrent.Future modifyUserGroupAsync(ModifyUserGroupRequest modifyUserGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param purchaseReservedCacheNodesOfferingRequest * Represents the input of a PurchaseReservedCacheNodesOffering operation. * @return A Java Future containing the result of the PurchaseReservedCacheNodesOffering operation returned by the * service. * @sample AmazonElastiCacheAsync.PurchaseReservedCacheNodesOffering * @see AWS API Documentation */ java.util.concurrent.Future purchaseReservedCacheNodesOfferingAsync( PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest); /** *

* 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. *

* * @param purchaseReservedCacheNodesOfferingRequest * Represents the input of a PurchaseReservedCacheNodesOffering operation. * @param 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. * @return A Java Future containing the result of the PurchaseReservedCacheNodesOffering operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.PurchaseReservedCacheNodesOffering * @see AWS API Documentation */ java.util.concurrent.Future purchaseReservedCacheNodesOfferingAsync( PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Redistribute slots to ensure uniform distribution across existing shards in the cluster. *

* * @param rebalanceSlotsInGlobalReplicationGroupRequest * @return A Java Future containing the result of the RebalanceSlotsInGlobalReplicationGroup operation returned by * the service. * @sample AmazonElastiCacheAsync.RebalanceSlotsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future rebalanceSlotsInGlobalReplicationGroupAsync( RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest); /** *

* Redistribute slots to ensure uniform distribution across existing shards in the cluster. *

* * @param rebalanceSlotsInGlobalReplicationGroupRequest * @param 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. * @return A Java Future containing the result of the RebalanceSlotsInGlobalReplicationGroup operation returned by * the service. * @sample AmazonElastiCacheAsyncHandler.RebalanceSlotsInGlobalReplicationGroup * @see AWS API Documentation */ java.util.concurrent.Future rebalanceSlotsInGlobalReplicationGroupAsync( RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param rebootCacheClusterRequest * Represents the input of a RebootCacheCluster operation. * @return A Java Future containing the result of the RebootCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsync.RebootCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future rebootCacheClusterAsync(RebootCacheClusterRequest rebootCacheClusterRequest); /** *

* 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. *

* * @param rebootCacheClusterRequest * Represents the input of a RebootCacheCluster operation. * @param 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. * @return A Java Future containing the result of the RebootCacheCluster operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.RebootCacheCluster * @see AWS * API Documentation */ java.util.concurrent.Future rebootCacheClusterAsync(RebootCacheClusterRequest rebootCacheClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param removeTagsFromResourceRequest * Represents the input of a RemoveTagsFromResource operation. * @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service. * @sample AmazonElastiCacheAsync.RemoveTagsFromResource * @see AWS API Documentation */ java.util.concurrent.Future removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest); /** *

* 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. *

* * @param removeTagsFromResourceRequest * Represents the input of a RemoveTagsFromResource operation. * @param 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. * @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.RemoveTagsFromResource * @see AWS API Documentation */ java.util.concurrent.Future removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param resetCacheParameterGroupRequest * Represents the input of a ResetCacheParameterGroup operation. * @return A Java Future containing the result of the ResetCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsync.ResetCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future resetCacheParameterGroupAsync(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest); /** *

* Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific * parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the * ResetAllParameters and CacheParameterGroupName parameters. *

* * @param resetCacheParameterGroupRequest * Represents the input of a ResetCacheParameterGroup operation. * @param 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. * @return A Java Future containing the result of the ResetCacheParameterGroup operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.ResetCacheParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future resetCacheParameterGroupAsync(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security * group that had been previously authorized. *

* * @param revokeCacheSecurityGroupIngressRequest * Represents the input of a RevokeCacheSecurityGroupIngress operation. * @return A Java Future containing the result of the RevokeCacheSecurityGroupIngress operation returned by the * service. * @sample AmazonElastiCacheAsync.RevokeCacheSecurityGroupIngress * @see AWS API Documentation */ java.util.concurrent.Future revokeCacheSecurityGroupIngressAsync( RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest); /** *

* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security * group that had been previously authorized. *

* * @param revokeCacheSecurityGroupIngressRequest * Represents the input of a RevokeCacheSecurityGroupIngress operation. * @param 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. * @return A Java Future containing the result of the RevokeCacheSecurityGroupIngress operation returned by the * service. * @sample AmazonElastiCacheAsyncHandler.RevokeCacheSecurityGroupIngress * @see AWS API Documentation */ java.util.concurrent.Future revokeCacheSecurityGroupIngressAsync( RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Start the migration of data. *

* * @param startMigrationRequest * @return A Java Future containing the result of the StartMigration operation returned by the service. * @sample AmazonElastiCacheAsync.StartMigration * @see AWS API * Documentation */ java.util.concurrent.Future startMigrationAsync(StartMigrationRequest startMigrationRequest); /** *

* Start the migration of data. *

* * @param startMigrationRequest * @param 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. * @return A Java Future containing the result of the StartMigration operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.StartMigration * @see AWS API * Documentation */ java.util.concurrent.Future startMigrationAsync(StartMigrationRequest startMigrationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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: *

    *
      *
    1. *

      * Replication group message: Test Failover API called for node group <node-group-id> *

      *
    2. *
    3. *

      * Cache cluster message: * Failover from primary node <primary-node-id> to replica node <node-id> completed *

      *
    4. *
    5. *

      * Replication group message: * Failover from primary node <primary-node-id> to replica node <node-id> completed *

      *
    6. *
    7. *

      * Cache cluster message: Recovering cache nodes <node-id> *

      *
    8. *
    9. *

      * Cache cluster message: Finished recovery for cache nodes <node-id> *

      *
    10. *
    *

    * For more information see: *

    * *
  • *
*

* Also see, Testing * Multi-AZ in the ElastiCache User Guide. *

* * @param testFailoverRequest * @return A Java Future containing the result of the TestFailover operation returned by the service. * @sample AmazonElastiCacheAsync.TestFailover * @see AWS API * Documentation */ java.util.concurrent.Future testFailoverAsync(TestFailoverRequest testFailoverRequest); /** *

* 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: *

    *
      *
    1. *

      * Replication group message: Test Failover API called for node group <node-group-id> *

      *
    2. *
    3. *

      * Cache cluster message: * Failover from primary node <primary-node-id> to replica node <node-id> completed *

      *
    4. *
    5. *

      * Replication group message: * Failover from primary node <primary-node-id> to replica node <node-id> completed *

      *
    6. *
    7. *

      * Cache cluster message: Recovering cache nodes <node-id> *

      *
    8. *
    9. *

      * Cache cluster message: Finished recovery for cache nodes <node-id> *

      *
    10. *
    *

    * For more information see: *

    * *
  • *
*

* Also see, Testing * Multi-AZ in the ElastiCache User Guide. *

* * @param testFailoverRequest * @param 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. * @return A Java Future containing the result of the TestFailover operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.TestFailover * @see AWS API * Documentation */ java.util.concurrent.Future testFailoverAsync(TestFailoverRequest testFailoverRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Async API to test connection between source and target replication group. *

* * @param testMigrationRequest * @return A Java Future containing the result of the TestMigration operation returned by the service. * @sample AmazonElastiCacheAsync.TestMigration * @see AWS API * Documentation */ java.util.concurrent.Future testMigrationAsync(TestMigrationRequest testMigrationRequest); /** *

* Async API to test connection between source and target replication group. *

* * @param testMigrationRequest * @param 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. * @return A Java Future containing the result of the TestMigration operation returned by the service. * @sample AmazonElastiCacheAsyncHandler.TestMigration * @see AWS API * Documentation */ java.util.concurrent.Future testMigrationAsync(TestMigrationRequest testMigrationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy