AbstractAmazonElastiCache (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticache.AbstractAmazonElastiCache

All Implemented Interfaces:

AmazonElastiCache

Direct Known Subclasses:

AbstractAmazonElastiCacheAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonElastiCache
extends Object
implements AmazonElastiCache
```
Abstract implementation of AmazonElastiCache. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.elasticache.AmazonElastiCache
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest request)` A tag is a key-value pair where the key and value are case-sensitive.
`CacheSecurityGroup`	`authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)` Allows network ingress to a cache security group.
`BatchApplyUpdateActionResult`	`batchApplyUpdateAction(BatchApplyUpdateActionRequest request)` Apply the service update.
`BatchStopUpdateActionResult`	`batchStopUpdateAction(BatchStopUpdateActionRequest request)` Stop the service update.
`ReplicationGroup`	`completeMigration(CompleteMigrationRequest request)` Complete the migration of data.
`Snapshot`	`copySnapshot(CopySnapshotRequest request)` Makes a copy of an existing snapshot.
`CacheCluster`	`createCacheCluster(CreateCacheClusterRequest request)` Creates a cluster.
`CacheParameterGroup`	`createCacheParameterGroup(CreateCacheParameterGroupRequest request)` Creates a new Amazon ElastiCache cache parameter group.
`CacheSecurityGroup`	`createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)` Creates a new cache security group.
`CacheSubnetGroup`	`createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)` Creates a new cache subnet group.
`GlobalReplicationGroup`	`createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)` Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.
`ReplicationGroup`	`createReplicationGroup(CreateReplicationGroupRequest request)` Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
`Snapshot`	`createSnapshot(CreateSnapshotRequest request)` Creates a copy of an entire cluster or replication group at a specific moment in time.
`CreateUserResult`	`createUser(CreateUserRequest request)` For Redis engine version 6.0 onwards: Creates a Redis user.
`CreateUserGroupResult`	`createUserGroup(CreateUserGroupRequest request)` For Redis engine version 6.0 onwards: Creates a Redis user group.
`GlobalReplicationGroup`	`decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)` Decreases the number of node groups in a Global datastore
`ReplicationGroup`	`decreaseReplicaCount(DecreaseReplicaCountRequest request)` Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
`CacheCluster`	`deleteCacheCluster(DeleteCacheClusterRequest request)` Deletes a previously provisioned cluster.
`DeleteCacheParameterGroupResult`	`deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)` Deletes the specified cache parameter group.
`DeleteCacheSecurityGroupResult`	`deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)` Deletes a cache security group.
`DeleteCacheSubnetGroupResult`	`deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)` Deletes a cache subnet group.
`GlobalReplicationGroup`	`deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)` Deleting a Global datastore is a two-step process:
`ReplicationGroup`	`deleteReplicationGroup(DeleteReplicationGroupRequest request)` Deletes an existing replication group.
`Snapshot`	`deleteSnapshot(DeleteSnapshotRequest request)` Deletes an existing snapshot.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` For Redis engine version 6.0 onwards: Deletes a user.
`DeleteUserGroupResult`	`deleteUserGroup(DeleteUserGroupRequest request)` For Redis engine version 6.0 onwards: Deletes a user group.
`DescribeCacheClustersResult`	`describeCacheClusters()` Simplified method form for invoking the DescribeCacheClusters operation.
`DescribeCacheClustersResult`	`describeCacheClusters(DescribeCacheClustersRequest request)` Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
`DescribeCacheEngineVersionsResult`	`describeCacheEngineVersions()` Simplified method form for invoking the DescribeCacheEngineVersions operation.
`DescribeCacheEngineVersionsResult`	`describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)` Returns a list of the available cache engines and their versions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups()` Simplified method form for invoking the DescribeCacheParameterGroups operation.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)` Returns a list of cache parameter group descriptions.
`DescribeCacheParametersResult`	`describeCacheParameters(DescribeCacheParametersRequest request)` Returns the detailed parameter list for a particular cache parameter group.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups()` Simplified method form for invoking the DescribeCacheSecurityGroups operation.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)` Returns a list of cache security group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups()` Simplified method form for invoking the DescribeCacheSubnetGroups operation.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)` Returns a list of cache subnet group descriptions.
`EngineDefaults`	`describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)` Returns the default engine and system parameter information for the specified cache engine.
`DescribeEventsResult`	`describeEvents()` Simplified method form for invoking the DescribeEvents operation.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns events related to clusters, cache security groups, and cache parameter groups.
`DescribeGlobalReplicationGroupsResult`	`describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)` Returns information about a particular global replication group.
`DescribeReplicationGroupsResult`	`describeReplicationGroups()` Simplified method form for invoking the DescribeReplicationGroups operation.
`DescribeReplicationGroupsResult`	`describeReplicationGroups(DescribeReplicationGroupsRequest request)` Returns information about a particular replication group.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes()` Simplified method form for invoking the DescribeReservedCacheNodes operation.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)` Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings()` Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)` Lists available reserved cache node offerings.
`DescribeServiceUpdatesResult`	`describeServiceUpdates(DescribeServiceUpdatesRequest request)` Returns details of the service updates
`DescribeSnapshotsResult`	`describeSnapshots()` Simplified method form for invoking the DescribeSnapshots operation.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest request)` Returns information about cluster or replication group snapshots.
`DescribeUpdateActionsResult`	`describeUpdateActions(DescribeUpdateActionsRequest request)` Returns details of the update actions
`DescribeUserGroupsResult`	`describeUserGroups(DescribeUserGroupsRequest request)` Returns a list of user groups.
`DescribeUsersResult`	`describeUsers(DescribeUsersRequest request)` Returns a list of users.
`GlobalReplicationGroup`	`disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)` Remove a secondary cluster from the Global datastore using the Global datastore name.
`GlobalReplicationGroup`	`failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)` Used to failover the primary region to a secondary region.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GlobalReplicationGroup`	`increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)` Increase the number of node groups in the Global datastore
`ReplicationGroup`	`increaseReplicaCount(IncreaseReplicaCountRequest request)` Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
`ListAllowedNodeTypeModificationsResult`	`listAllowedNodeTypeModifications()` Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
`ListAllowedNodeTypeModificationsResult`	`listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)` Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all tags currently on a named resource.
`CacheCluster`	`modifyCacheCluster(ModifyCacheClusterRequest request)` Modifies the settings for a cluster.
`ModifyCacheParameterGroupResult`	`modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)` Modifies the parameters of a cache parameter group.
`CacheSubnetGroup`	`modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)` Modifies an existing cache subnet group.
`GlobalReplicationGroup`	`modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)` Modifies the settings for a Global datastore.
`ReplicationGroup`	`modifyReplicationGroup(ModifyReplicationGroupRequest request)` Modifies the settings for a replication group.
`ReplicationGroup`	`modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)` Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
`ModifyUserResult`	`modifyUser(ModifyUserRequest request)` Changes user password(s) and/or access string.
`ModifyUserGroupResult`	`modifyUserGroup(ModifyUserGroupRequest request)` Changes the list of users that belong to the user group.
`ReservedCacheNode`	`purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)` Allows you to purchase a reserved cache node offering.
`GlobalReplicationGroup`	`rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)` Redistribute slots to ensure uniform distribution across existing shards in the cluster.
`CacheCluster`	`rebootCacheCluster(RebootCacheClusterRequest request)` Reboots some, or all, of the cache nodes within a provisioned cluster.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest request)` Removes the tags identified by the `TagKeys` list from the named resource.
`ResetCacheParameterGroupResult`	`resetCacheParameterGroup(ResetCacheParameterGroupRequest request)` Modifies the parameters of a cache parameter group to the engine or system default value.
`CacheSecurityGroup`	`revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)` Revokes ingress from a cache security group.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("elasticache.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonElastiCache.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`ReplicationGroup`	`startMigration(StartMigrationRequest request)` Start the migration of data.
`ReplicationGroup`	`testFailover(TestFailoverRequest request)` Represents the input of a `TestFailover` operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
`AmazonElastiCacheWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonElastiCache
    
    Overrides the default endpoint for this client ("elasticache.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "elasticache.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonElastiCache
    
    Parameters:
    
    endpoint - The endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "elasticache.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonElastiCache
    
    An alternative to AmazonElastiCache.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonElastiCache
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTagsToResource
```
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    addTagsToResource in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of an AddTagsToResource operation.
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - authorizeCacheSecurityGroupIngress
```
public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    authorizeCacheSecurityGroupIngress in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
    
    Returns:
    
    Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchApplyUpdateAction
```
public BatchApplyUpdateActionResult batchApplyUpdateAction(BatchApplyUpdateActionRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
    
    Specified by:
    
    batchApplyUpdateAction in interface AmazonElastiCache
    
    Returns:
    
    Result of the BatchApplyUpdateAction operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchStopUpdateAction
```
public BatchStopUpdateActionResult batchStopUpdateAction(BatchStopUpdateActionRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
    
    Specified by:
    
    batchStopUpdateAction in interface AmazonElastiCache
    
    Returns:
    
    Result of the BatchStopUpdateAction operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - completeMigration
```
public ReplicationGroup completeMigration(CompleteMigrationRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Complete the migration of data.
    
    Specified by:
    
    completeMigration in interface AmazonElastiCache
    
    Returns:
    
    Result of the CompleteMigration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copySnapshot
```
public Snapshot copySnapshot(CopySnapshotRequest request)
```
    Description copied from interface: AmazonElastiCache
    Makes a copy of an existing snapshot.
    
    This operation is valid for Redis only.
    
    Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
    
    You could receive the following error messages.
    
    Error Messages
    - Error Message: The S3 bucket %s is outside of the region.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The S3 bucket %s does not exist.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The S3 bucket %s is not owned by the authenticated user.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
      
      Solution: Contact your system administrator to get the needed permissions.
    - Error Message: The S3 bucket %s already contains an object with key %s.
      
      Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
    - Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
      
      Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
      
      Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
      
      Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    Specified by:
    
    copySnapshot in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CopySnapshotMessage operation.
    
    Returns:
    
    Result of the CopySnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCacheCluster
```
public CacheCluster createCacheCluster(CreateCacheClusterRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
    
    This operation is not supported for Redis (cluster mode enabled) clusters.
    
    Specified by:
    
    createCacheCluster in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateCacheCluster operation.
    
    Returns:
    
    Result of the CreateCacheCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCacheParameterGroup
```
public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
    
    A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
    - ModifyCacheParameterGroup in the ElastiCache API Reference.
    - Parameters and Parameter Groups in the ElastiCache User Guide.
    Specified by:
    
    createCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateCacheParameterGroup operation.
    
    Returns:
    
    Result of the CreateCacheParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCacheSecurityGroup
```
public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    createCacheSecurityGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateCacheSecurityGroup operation.
    
    Returns:
    
    Result of the CreateCacheSecurityGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCacheSubnetGroup
```
public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Creates a new cache subnet group.
    
    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
    
    Specified by:
    
    createCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateCacheSubnetGroup operation.
    
    Returns:
    
    Result of the CreateCacheSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGlobalReplicationGroup
```
public GlobalReplicationGroup createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis 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.
    Specified by:
    
    createGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the CreateGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationGroup
```
public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Creates a Redis (cluster mode disabled) or a Redis (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 (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
    
    A Redis cluster-mode enabled 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 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 (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 avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
    
    This operation is valid for Redis only.
    
    Specified by:
    
    createReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateReplicationGroup operation.
    
    Returns:
    
    Result of the CreateReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
public Snapshot createSnapshot(CreateSnapshotRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Creates a copy of an entire cluster or replication group at a specific moment in time.
    
    This operation is valid for Redis only.
    
    Specified by:
    
    createSnapshot in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a CreateSnapshot operation.
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
    
    Specified by:
    
    createUser in interface AmazonElastiCache
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUserGroup
```
public CreateUserGroupResult createUserGroup(CreateUserGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
    
    Specified by:
    
    createUserGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the CreateUserGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - decreaseNodeGroupsInGlobalReplicationGroup
```
public GlobalReplicationGroup decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Decreases the number of node groups in a Global datastore
    
    Specified by:
    
    decreaseNodeGroupsInGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - decreaseReplicaCount
```
public ReplicationGroup decreaseReplicaCount(DecreaseReplicaCountRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
    
    Specified by:
    
    decreaseReplicaCount in interface AmazonElastiCache
    
    Returns:
    
    Result of the DecreaseReplicaCount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheCluster
```
public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest request)
```
    Description copied from interface: AmazonElastiCache
    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 (cluster mode enabled) clusters
    - Redis (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 (cluster mode enabled) replication group
    - A cluster that is not in the available state
    Specified by:
    
    deleteCacheCluster in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteCacheCluster operation.
    
    Returns:
    
    Result of the DeleteCacheCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheParameterGroup
```
public DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    deleteCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteCacheParameterGroup operation.
    
    Returns:
    
    Result of the DeleteCacheParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheSecurityGroup
```
public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Deletes a cache security group.
    
    You cannot delete a cache security group if it is associated with any clusters.
    
    Specified by:
    
    deleteCacheSecurityGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteCacheSecurityGroup operation.
    
    Returns:
    
    Result of the DeleteCacheSecurityGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheSubnetGroup
```
public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Deletes a cache subnet group.
    
    You cannot delete a default cache subnet group or one that is associated with any clusters.
    
    Specified by:
    
    deleteCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteCacheSubnetGroup operation.
    
    Returns:
    
    Result of the DeleteCacheSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGlobalReplicationGroup
```
public GlobalReplicationGroup deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    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.
    Specified by:
    
    deleteGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the DeleteGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationGroup
```
public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
    
    When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
    
    This operation is valid for Redis only.
    
    Specified by:
    
    deleteReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteReplicationGroup operation.
    
    Returns:
    
    Result of the DeleteReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSnapshot
```
public Snapshot deleteSnapshot(DeleteSnapshotRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
    
    This operation is valid for Redis only.
    
    Specified by:
    
    deleteSnapshot in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DeleteSnapshot operation.
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    For Redis 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).
    
    Specified by:
    
    deleteUser in interface AmazonElastiCache
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserGroup
```
public DeleteUserGroupResult deleteUserGroup(DeleteUserGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    For Redis 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).
    
    Specified by:
    
    deleteUserGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the DeleteUserGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheClusters
```
public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    describeCacheClusters in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheClusters operation.
    
    Returns:
    
    Result of the DescribeCacheClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheClusters
```
public DescribeCacheClustersResult describeCacheClusters()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeCacheClusters operation.
    
    Specified by:
    
    describeCacheClusters in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)
  - describeCacheEngineVersions
```
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns a list of the available cache engines and their versions.
    
    Specified by:
    
    describeCacheEngineVersions in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheEngineVersions operation.
    
    Returns:
    
    Result of the DescribeCacheEngineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheEngineVersions
```
public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeCacheEngineVersions operation.
    
    Specified by:
    
    describeCacheEngineVersions in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
  - describeCacheParameterGroups
```
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    describeCacheParameterGroups in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheParameterGroups operation.
    
    Returns:
    
    Result of the DescribeCacheParameterGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheParameterGroups
```
public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeCacheParameterGroups operation.
    
    Specified by:
    
    describeCacheParameterGroups in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
  - describeCacheParameters
```
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns the detailed parameter list for a particular cache parameter group.
    
    Specified by:
    
    describeCacheParameters in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheParameters operation.
    
    Returns:
    
    Result of the DescribeCacheParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSecurityGroups
```
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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
    
    Specified by:
    
    describeCacheSecurityGroups in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheSecurityGroups operation.
    
    Returns:
    
    Result of the DescribeCacheSecurityGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSecurityGroups
```
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeCacheSecurityGroups operation.
    
    Specified by:
    
    describeCacheSecurityGroups in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
  - describeCacheSubnetGroups
```
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    describeCacheSubnetGroups in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeCacheSubnetGroups operation.
    
    Returns:
    
    Result of the DescribeCacheSubnetGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSubnetGroups
```
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeCacheSubnetGroups operation.
    
    Specified by:
    
    describeCacheSubnetGroups in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
  - describeEngineDefaultParameters
```
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns the default engine and system parameter information for the specified cache engine.
    
    Specified by:
    
    describeEngineDefaultParameters in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeEngineDefaultParameters operation.
    
    Returns:
    
    Result of the DescribeEngineDefaultParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    describeEvents in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeEvents operation.
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeEvents operation.
    
    Specified by:
    
    describeEvents in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeEvents(DescribeEventsRequest)
  - describeGlobalReplicationGroups
```
public DescribeGlobalReplicationGroupsResult describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
    
    Specified by:
    
    describeGlobalReplicationGroups in interface AmazonElastiCache
    
    Returns:
    
    Result of the DescribeGlobalReplicationGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationGroups
```
public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
    
    This operation is valid for Redis only.
    
    Specified by:
    
    describeReplicationGroups in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeReplicationGroups operation.
    
    Returns:
    
    Result of the DescribeReplicationGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationGroups
```
public DescribeReplicationGroupsResult describeReplicationGroups()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeReplicationGroups operation.
    
    Specified by:
    
    describeReplicationGroups in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)
  - describeReservedCacheNodes
```
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
    
    Specified by:
    
    describeReservedCacheNodes in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeReservedCacheNodes operation.
    
    Returns:
    
    Result of the DescribeReservedCacheNodes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReservedCacheNodes
```
public DescribeReservedCacheNodesResult describeReservedCacheNodes()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeReservedCacheNodes operation.
    
    Specified by:
    
    describeReservedCacheNodes in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
  - describeReservedCacheNodesOfferings
```
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Lists available reserved cache node offerings.
    
    Specified by:
    
    describeReservedCacheNodesOfferings in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeReservedCacheNodesOfferings operation.
    
    Returns:
    
    Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReservedCacheNodesOfferings
```
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
    
    Specified by:
    
    describeReservedCacheNodesOfferings in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
  - describeServiceUpdates
```
public DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns details of the service updates
    
    Specified by:
    
    describeServiceUpdates in interface AmazonElastiCache
    
    Returns:
    
    Result of the DescribeServiceUpdates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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 only.
    
    Specified by:
    
    describeSnapshots in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a DescribeSnapshotsMessage operation.
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the DescribeSnapshots operation.
    
    Specified by:
    
    describeSnapshots in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)
  - describeUpdateActions
```
public DescribeUpdateActionsResult describeUpdateActions(DescribeUpdateActionsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns details of the update actions
    
    Specified by:
    
    describeUpdateActions in interface AmazonElastiCache
    
    Returns:
    
    Result of the DescribeUpdateActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUserGroups
```
public DescribeUserGroupsResult describeUserGroups(DescribeUserGroupsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns a list of user groups.
    
    Specified by:
    
    describeUserGroups in interface AmazonElastiCache
    
    Returns:
    
    Result of the DescribeUserGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns a list of users.
    
    Specified by:
    
    describeUsers in interface AmazonElastiCache
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateGlobalReplicationGroup
```
public GlobalReplicationGroup disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    disassociateGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the DisassociateGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - failoverGlobalReplicationGroup
```
public GlobalReplicationGroup failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
    
    Specified by:
    
    failoverGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the FailoverGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - increaseNodeGroupsInGlobalReplicationGroup
```
public GlobalReplicationGroup increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Increase the number of node groups in the Global datastore
    
    Specified by:
    
    increaseNodeGroupsInGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - increaseReplicaCount
```
public ReplicationGroup increaseReplicaCount(IncreaseReplicaCountRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
    
    Specified by:
    
    increaseReplicaCount in interface AmazonElastiCache
    
    Returns:
    
    Result of the IncreaseReplicaCount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAllowedNodeTypeModifications
```
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Lists all available node types that you can scale your Redis 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.
    
    Specified by:
    
    listAllowedNodeTypeModifications in interface AmazonElastiCache
    
    Parameters:
    
    request - The input parameters for the ListAllowedNodeTypeModifications operation.
    
    Returns:
    
    Result of the ListAllowedNodeTypeModifications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAllowedNodeTypeModifications
```
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
```
    Description copied from interface: AmazonElastiCache
    
    Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
    
    Specified by:
    
    listAllowedNodeTypeModifications in interface AmazonElastiCache
    
    See Also:
    
    AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    listTagsForResource in interface AmazonElastiCache
    
    Parameters:
    
    request - The input parameters for the ListTagsForResource operation.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheCluster
```
public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    modifyCacheCluster in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a ModifyCacheCluster operation.
    
    Returns:
    
    Result of the ModifyCacheCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheParameterGroup
```
public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    modifyCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a ModifyCacheParameterGroup operation.
    
    Returns:
    
    Result of the ModifyCacheParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheSubnetGroup
```
public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Modifies an existing cache subnet group.
    
    Specified by:
    
    modifyCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a ModifyCacheSubnetGroup operation.
    
    Returns:
    
    Result of the ModifyCacheSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyGlobalReplicationGroup
```
public GlobalReplicationGroup modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Modifies the settings for a Global datastore.
    
    Specified by:
    
    modifyGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the ModifyGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationGroup
```
public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    Modifies the settings for a replication group.
    - Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
    - ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
    This operation is valid for Redis only.
    Specified by:
    
    modifyReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a ModifyReplicationGroups operation.
    
    Returns:
    
    Result of the ModifyReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationGroupShardConfiguration
```
public ReplicationGroup modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
    
    Specified by:
    
    modifyReplicationGroupShardConfiguration in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input for a ModifyReplicationGroupShardConfiguration operation.
    
    Returns:
    
    Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyUser
```
public ModifyUserResult modifyUser(ModifyUserRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Changes user password(s) and/or access string.
    
    Specified by:
    
    modifyUser in interface AmazonElastiCache
    
    Returns:
    
    Result of the ModifyUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyUserGroup
```
public ModifyUserGroupResult modifyUserGroup(ModifyUserGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Changes the list of users that belong to the user group.
    
    Specified by:
    
    modifyUserGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the ModifyUserGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - purchaseReservedCacheNodesOffering
```
public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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 or Managing Costs with Reserved Nodes for Memcached.
    
    Specified by:
    
    purchaseReservedCacheNodesOffering in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a PurchaseReservedCacheNodesOffering operation.
    
    Returns:
    
    Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebalanceSlotsInGlobalReplicationGroup
```
public GlobalReplicationGroup rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Redistribute slots to ensure uniform distribution across existing shards in the cluster.
    
    Specified by:
    
    rebalanceSlotsInGlobalReplicationGroup in interface AmazonElastiCache
    
    Returns:
    
    Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootCacheCluster
```
public CacheCluster rebootCacheCluster(RebootCacheClusterRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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 (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
    
    If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
    
    Specified by:
    
    rebootCacheCluster in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a RebootCacheCluster operation.
    
    Returns:
    
    Result of the RebootCacheCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromResource
```
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    removeTagsFromResource in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a RemoveTagsFromResource operation.
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetCacheParameterGroup
```
public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    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.
    
    Specified by:
    
    resetCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a ResetCacheParameterGroup operation.
    
    Returns:
    
    Result of the ResetCacheParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - revokeCacheSecurityGroupIngress
```
public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
    
    Specified by:
    
    revokeCacheSecurityGroupIngress in interface AmazonElastiCache
    
    Parameters:
    
    request - Represents the input of a RevokeCacheSecurityGroupIngress operation.
    
    Returns:
    
    Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startMigration
```
public ReplicationGroup startMigration(StartMigrationRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Start the migration of data.
    
    Specified by:
    
    startMigration in interface AmazonElastiCache
    
    Returns:
    
    Result of the StartMigration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testFailover
```
public ReplicationGroup testFailover(TestFailoverRequest request)
```
    Description copied from interface: AmazonElastiCache
    Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
    
    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 5 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 (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
    - To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
      
      Replication group message: Test Failover API called for node group <node-group-id>
      
      Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
      
      Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
      
      Cache cluster message: Recovering cache nodes <node-id>
      
      Cache cluster message: Finished recovery for cache nodes <node-id>
      
      For more information see:
      
      Viewing ElastiCache Events in the ElastiCache User Guide
      
      DescribeEvents in the ElastiCache API Reference
    Also see, Testing Multi-AZ in the ElastiCache User Guide.
    Specified by:
    
    testFailover in interface AmazonElastiCache
    
    Returns:
    
    Result of the TestFailover operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonElastiCache
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonElastiCache
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonElastiCache
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonElastiCache
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonElastiCacheWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonElastiCache

Did this page help you?

Class AbstractAmazonElastiCache

Field Summary

Fields inherited from interface com.amazonaws.services.elasticache.AmazonElastiCache

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addTagsToResource

authorizeCacheSecurityGroupIngress

batchApplyUpdateAction

batchStopUpdateAction

completeMigration

copySnapshot

createCacheCluster

createCacheParameterGroup

createCacheSecurityGroup

createCacheSubnetGroup

createGlobalReplicationGroup

createReplicationGroup

createSnapshot

createUser

createUserGroup

decreaseNodeGroupsInGlobalReplicationGroup

decreaseReplicaCount

deleteCacheCluster

deleteCacheParameterGroup

deleteCacheSecurityGroup

deleteCacheSubnetGroup

deleteGlobalReplicationGroup

deleteReplicationGroup

deleteSnapshot

deleteUser

deleteUserGroup

describeCacheClusters

describeCacheClusters

describeCacheEngineVersions

describeCacheEngineVersions

describeCacheParameterGroups

describeCacheParameterGroups

describeCacheParameters

describeCacheSecurityGroups

describeCacheSecurityGroups

describeCacheSubnetGroups

describeCacheSubnetGroups

describeEngineDefaultParameters

describeEvents

describeEvents

describeGlobalReplicationGroups

describeReplicationGroups

describeReplicationGroups

describeReservedCacheNodes

describeReservedCacheNodes

describeReservedCacheNodesOfferings

describeReservedCacheNodesOfferings

describeServiceUpdates

describeSnapshots

describeSnapshots

describeUpdateActions

describeUserGroups

describeUsers

disassociateGlobalReplicationGroup

failoverGlobalReplicationGroup

increaseNodeGroupsInGlobalReplicationGroup

increaseReplicaCount

listAllowedNodeTypeModifications

listAllowedNodeTypeModifications

listTagsForResource

modifyCacheCluster

modifyCacheParameterGroup

modifyCacheSubnetGroup

modifyGlobalReplicationGroup

modifyReplicationGroup

modifyReplicationGroupShardConfiguration

modifyUser

modifyUserGroup

purchaseReservedCacheNodesOffering

rebalanceSlotsInGlobalReplicationGroup

rebootCacheCluster