AmazonElastiCache (AWS SDK for Java

All Known Subinterfaces:

AmazonElastiCacheAsync

All Known Implementing Classes:

AbstractAmazonElastiCache, AbstractAmazonElastiCacheAsync, AmazonElastiCacheAsyncClient, AmazonElastiCacheClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonElastiCache
```
Interface for accessing Amazon ElastiCache.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonElastiCache 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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)` Adds up to 50 cost allocation tags to the named resource.
`CacheSecurityGroup`	`authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)` Allows network ingress to a cache security group.
`Snapshot`	`copySnapshot(CopySnapshotRequest copySnapshotRequest)` Makes a copy of an existing snapshot.
`CacheCluster`	`createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)` Creates a cluster.
`CacheParameterGroup`	`createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)` Creates a new Amazon ElastiCache cache parameter group.
`CacheSecurityGroup`	`createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)` Creates a new cache security group.
`CacheSubnetGroup`	`createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)` Creates a new cache subnet group.
`ReplicationGroup`	`createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)` Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
`Snapshot`	`createSnapshot(CreateSnapshotRequest createSnapshotRequest)` Creates a copy of an entire cluster or replication group at a specific moment in time.
`CacheCluster`	`deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)` Deletes a previously provisioned cluster.
`DeleteCacheParameterGroupResult`	`deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)` Deletes the specified cache parameter group.
`DeleteCacheSecurityGroupResult`	`deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)` Deletes a cache security group.
`DeleteCacheSubnetGroupResult`	`deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)` Deletes a cache subnet group.
`ReplicationGroup`	`deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)` Deletes an existing replication group.
`Snapshot`	`deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)` Deletes an existing snapshot.
`DescribeCacheClustersResult`	`describeCacheClusters()` Simplified method form for invoking the DescribeCacheClusters operation.
`DescribeCacheClustersResult`	`describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)` Returns information about all provisioned 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 describeCacheEngineVersionsRequest)` Returns a list of the available cache engines and their versions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups()` Simplified method form for invoking the DescribeCacheParameterGroups operation.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)` Returns a list of cache parameter group descriptions.
`DescribeCacheParametersResult`	`describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)` Returns the detailed parameter list for a particular cache parameter group.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups()` Simplified method form for invoking the DescribeCacheSecurityGroups operation.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)` Returns a list of cache security group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups()` Simplified method form for invoking the DescribeCacheSubnetGroups operation.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)` Returns a list of cache subnet group descriptions.
`EngineDefaults`	`describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)` Returns the default engine and system parameter information for the specified cache engine.
`DescribeEventsResult`	`describeEvents()` Simplified method form for invoking the DescribeEvents operation.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest describeEventsRequest)` Returns events related to clusters, cache security groups, and cache parameter groups.
`DescribeReplicationGroupsResult`	`describeReplicationGroups()` Simplified method form for invoking the DescribeReplicationGroups operation.
`DescribeReplicationGroupsResult`	`describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)` Returns information about a particular replication group.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes()` Simplified method form for invoking the DescribeReservedCacheNodes operation.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)` Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings()` Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)` Lists available reserved cache node offerings.
`DescribeSnapshotsResult`	`describeSnapshots()` Simplified method form for invoking the DescribeSnapshots operation.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)` Returns information about cluster or replication group snapshots.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAllowedNodeTypeModificationsResult`	`listAllowedNodeTypeModifications()` Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
`ListAllowedNodeTypeModificationsResult`	`listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)` Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists all cost allocation tags currently on the named resource.
`CacheCluster`	`modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)` Modifies the settings for a cluster.
`ModifyCacheParameterGroupResult`	`modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)` Modifies the parameters of a cache parameter group.
`CacheSubnetGroup`	`modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)` Modifies an existing cache subnet group.
`ReplicationGroup`	`modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)` Modifies the settings for a replication group.
`ReplicationGroup`	`modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)` Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime.
`ReservedCacheNode`	`purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)` Allows you to purchase a reserved cache node offering.
`CacheCluster`	`rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)` Reboots some, or all, of the cache nodes within a provisioned cluster.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)` Removes the tags identified by the `TagKeys` list from the named resource.
`ResetCacheParameterGroupResult`	`resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)` Modifies the parameters of a cache parameter group to the engine or system default value.
`CacheSecurityGroup`	`revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)` Revokes ingress from a cache security group.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`ReplicationGroup`	`testFailover(TestFailoverRequest testFailoverRequest)` 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()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    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.
    
    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
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    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
```
AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
```
    Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.
    
    When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
    
    Parameters:
    
    addTagsToResourceRequest - Represents the input of an AddTagsToResource operation.
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
    
    InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.
    
    See Also:
    
    AWS API Documentation
  - authorizeCacheSecurityGroupIngress
```
CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
```
    Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
    
    You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
    
    Parameters:
    
    authorizeCacheSecurityGroupIngressRequest - Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
    
    Returns:
    
    Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
    
    Throws:
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.
    
    AuthorizationAlreadyExistsException - The specified Amazon EC2 security group is already authorized for the specified cache security group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - copySnapshot
```
Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest)
```
    Makes a copy of an existing snapshot.
    
    This operation is valid for Redis only.
    
    Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
    
    You could receive the following error messages.
    
    Error Messages
    - Error Message: The S3 bucket %s is outside of the region.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The S3 bucket %s does not exist.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The S3 bucket %s is not owned by the authenticated user.
      
      Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
      
      Solution: Contact your system administrator to get the needed permissions.
    - Error Message: The S3 bucket %s already contains an object with key %s.
      
      Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
    - Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
      
      Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
      
      Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    - Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
      
      Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
    Parameters:
    
    copySnapshotRequest - Represents the input of a CopySnapshotMessage operation.
    
    Returns:
    
    Result of the CopySnapshot operation returned by the service.
    
    Throws:
    
    SnapshotAlreadyExistsException - You already have a snapshot with the given name.
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.
    
    InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - createCacheCluster
```
CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
```
    Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
    
    Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
    
    Parameters:
    
    createCacheClusterRequest - Represents the input of a CreateCacheCluster operation.
    
    Returns:
    
    Result of the CreateCacheCluster operation returned by the service.
    
    Throws:
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    CacheClusterAlreadyExistsException - You already have a cluster with the given identifier.
    
    InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.
    
    ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.
    
    NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
    
    NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidVPCNetworkStateException - The VPC network is in an invalid state.
    
    TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - createCacheParameterGroup
```
CacheParameterGroup createCacheParameterGroup(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:
    - ModifyCacheParameterGroup in the ElastiCache API Reference.
    - Parameters and Parameter Groups in the ElastiCache User Guide.
    Parameters:
    
    createCacheParameterGroupRequest - Represents the input of a CreateCacheParameterGroup operation.
    
    Returns:
    
    Result of the CreateCacheParameterGroup operation returned by the service.
    
    Throws:
    
    CacheParameterGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum number of cache security groups.
    
    CacheParameterGroupAlreadyExistsException - A cache parameter group with the requested name already exists.
    
    InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - createCacheSecurityGroup
```
CacheSecurityGroup createCacheSecurityGroup(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.
    
    Parameters:
    
    createCacheSecurityGroupRequest - Represents the input of a CreateCacheSecurityGroup operation.
    
    Returns:
    
    Result of the CreateCacheSecurityGroup operation returned by the service.
    
    Throws:
    
    CacheSecurityGroupAlreadyExistsException - A cache security group with the specified name already exists.
    
    CacheSecurityGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache security groups.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - createCacheSubnetGroup
```
CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
```
    Creates a new cache subnet group.
    
    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
    
    Parameters:
    
    createCacheSubnetGroupRequest - Represents the input of a CreateCacheSubnetGroup operation.
    
    Returns:
    
    Result of the CreateCacheSubnetGroup operation returned by the service.
    
    Throws:
    
    CacheSubnetGroupAlreadyExistsException - The requested cache subnet group name is already in use by an existing cache subnet group.
    
    CacheSubnetGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache subnet groups.
    
    CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
    
    InvalidSubnetException - An invalid subnet identifier was specified.
    
    See Also:
    
    AWS API Documentation
  - createReplicationGroup
```
ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
```
    Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
    
    A Redis (cluster mode disabled) replication group is a collection of 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) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
    
    When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.
    
    This operation is valid for Redis only.
    
    Parameters:
    
    createReplicationGroupRequest - Represents the input of a CreateReplicationGroup operation.
    
    Returns:
    
    Result of the CreateReplicationGroup operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    ReplicationGroupAlreadyExistsException - The specified replication group already exists.
    
    InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.
    
    ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.
    
    NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
    
    NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidVPCNetworkStateException - The VPC network is in an invalid state.
    
    TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
    
    NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 15
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - createSnapshot
```
Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest)
```
    Creates a copy of an entire cluster or replication group at a specific moment in time.
    
    This operation is valid for Redis only.
    Parameters:
    
    createSnapshotRequest - Represents the input of a CreateSnapshot operation.
    
    Returns:
    
    Result of the CreateSnapshot operation returned by the service.
    
    Throws:
    
    SnapshotAlreadyExistsException - You already have a snapshot with the given name.
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.
    SnapshotFeatureNotSupportedException - You attempted one of the following operations:
    
    Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
    
    Creating a snapshot of a cluster that is running Memcached rather than Redis.
    
    Neither of these are supported by ElastiCache.
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheCluster
```
CacheCluster deleteCacheCluster(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 cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group.
    
    Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
    Parameters:
    
    deleteCacheClusterRequest - Represents the input of a DeleteCacheCluster operation.
    
    Returns:
    
    Result of the DeleteCacheCluster operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    SnapshotAlreadyExistsException - You already have a snapshot with the given name.
    SnapshotFeatureNotSupportedException - You attempted one of the following operations:
    
    Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
    
    Creating a snapshot of a cluster that is running Memcached rather than Redis.
    
    Neither of these are supported by ElastiCache.
    SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheParameterGroup
```
DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
```
    Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
    
    Parameters:
    
    deleteCacheParameterGroupRequest - Represents the input of a DeleteCacheParameterGroup operation.
    
    Returns:
    
    Result of the DeleteCacheParameterGroup operation returned by the service.
    
    Throws:
    
    InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheSecurityGroup
```
DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
```
    Deletes a cache security group.
    
    You cannot delete a cache security group if it is associated with any clusters.
    
    Parameters:
    
    deleteCacheSecurityGroupRequest - Represents the input of a DeleteCacheSecurityGroup operation.
    
    Returns:
    
    Result of the DeleteCacheSecurityGroup operation returned by the service.
    
    Throws:
    
    InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - deleteCacheSubnetGroup
```
DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
```
    Deletes a cache subnet group.
    
    You cannot delete a cache subnet group if it is associated with any clusters.
    
    Parameters:
    
    deleteCacheSubnetGroupRequest - Represents the input of a DeleteCacheSubnetGroup operation.
    
    Returns:
    
    Result of the DeleteCacheSubnetGroup operation returned by the service.
    
    Throws:
    
    CacheSubnetGroupInUseException - The requested cache subnet group is currently in use.
    
    CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationGroup
```
ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
```
    Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
    
    When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
    
    This operation is valid for Redis only.
    Parameters:
    
    deleteReplicationGroupRequest - Represents the input of a DeleteReplicationGroup operation.
    
    Returns:
    
    Result of the DeleteReplicationGroup operation returned by the service.
    
    Throws:
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    SnapshotAlreadyExistsException - You already have a snapshot with the given name.
    SnapshotFeatureNotSupportedException - You attempted one of the following operations:
    
    Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
    
    Creating a snapshot of a cluster that is running Memcached rather than Redis.
    
    Neither of these are supported by ElastiCache.
    SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - deleteSnapshot
```
Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
```
    Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
    
    This operation is valid for Redis only.
    
    Parameters:
    
    deleteSnapshotRequest - Represents the input of a DeleteSnapshot operation.
    
    Returns:
    
    Result of the DeleteSnapshot operation returned by the service.
    
    Throws:
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeCacheClusters
```
DescribeCacheClustersResult describeCacheClusters(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.
    
    Parameters:
    
    describeCacheClustersRequest - Represents the input of a DescribeCacheClusters operation.
    
    Returns:
    
    Result of the DescribeCacheClusters operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeCacheClusters
```
DescribeCacheClustersResult describeCacheClusters()
```
    Simplified method form for invoking the DescribeCacheClusters operation.
    
    See Also:
    
    describeCacheClusters(DescribeCacheClustersRequest)
  - describeCacheEngineVersions
```
DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
```
    Returns a list of the available cache engines and their versions.
    
    Parameters:
    
    describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.
    
    Returns:
    
    Result of the DescribeCacheEngineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCacheEngineVersions
```
DescribeCacheEngineVersionsResult describeCacheEngineVersions()
```
    Simplified method form for invoking the DescribeCacheEngineVersions operation.
    
    See Also:
    
    describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
  - describeCacheParameterGroups
```
DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
```
    Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
    
    Parameters:
    
    describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.
    
    Returns:
    
    Result of the DescribeCacheParameterGroups operation returned by the service.
    
    Throws:
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeCacheParameterGroups
```
DescribeCacheParameterGroupsResult describeCacheParameterGroups()
```
    Simplified method form for invoking the DescribeCacheParameterGroups operation.
    
    See Also:
    
    describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
  - describeCacheParameters
```
DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
```
    Returns the detailed parameter list for a particular cache parameter group.
    
    Parameters:
    
    describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.
    
    Returns:
    
    Result of the DescribeCacheParameters operation returned by the service.
    
    Throws:
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSecurityGroups
```
DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
```
    Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
    
    Parameters:
    
    describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.
    
    Returns:
    
    Result of the DescribeCacheSecurityGroups operation returned by the service.
    
    Throws:
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSecurityGroups
```
DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
```
    Simplified method form for invoking the DescribeCacheSecurityGroups operation.
    
    See Also:
    
    describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
  - describeCacheSubnetGroups
```
DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
```
    Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
    
    Parameters:
    
    describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.
    
    Returns:
    
    Result of the DescribeCacheSubnetGroups operation returned by the service.
    
    Throws:
    
    CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.
    
    See Also:
    
    AWS API Documentation
  - describeCacheSubnetGroups
```
DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
```
    Simplified method form for invoking the DescribeCacheSubnetGroups operation.
    
    See Also:
    
    describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
  - describeEngineDefaultParameters
```
EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
```
    Returns the default engine and system parameter information for the specified cache engine.
    
    Parameters:
    
    describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.
    
    Returns:
    
    Result of the DescribeEngineDefaultParameters operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
DescribeEventsResult describeEvents(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.
    
    Parameters:
    
    describeEventsRequest - Represents the input of a DescribeEvents operation.
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
DescribeEventsResult describeEvents()
```
    Simplified method form for invoking the DescribeEvents operation.
    
    See Also:
    
    describeEvents(DescribeEventsRequest)
  - describeReplicationGroups
```
DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
```
    Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
    
    This operation is valid for Redis only.
    
    Parameters:
    
    describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.
    
    Returns:
    
    Result of the DescribeReplicationGroups operation returned by the service.
    
    Throws:
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationGroups
```
DescribeReplicationGroupsResult describeReplicationGroups()
```
    Simplified method form for invoking the DescribeReplicationGroups operation.
    
    See Also:
    
    describeReplicationGroups(DescribeReplicationGroupsRequest)
  - describeReservedCacheNodes
```
DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
```
    Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
    
    Parameters:
    
    describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.
    
    Returns:
    
    Result of the DescribeReservedCacheNodes operation returned by the service.
    
    Throws:
    
    ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeReservedCacheNodes
```
DescribeReservedCacheNodesResult describeReservedCacheNodes()
```
    Simplified method form for invoking the DescribeReservedCacheNodes operation.
    
    See Also:
    
    describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
  - describeReservedCacheNodesOfferings
```
DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
```
    Lists available reserved cache node offerings.
    
    Parameters:
    
    describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.
    
    Returns:
    
    Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
    
    Throws:
    
    ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeReservedCacheNodesOfferings
```
DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
```
    Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
    
    See Also:
    
    describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
  - describeSnapshots
```
DescribeSnapshotsResult describeSnapshots(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 only.
    
    Parameters:
    
    describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.
    
    Returns:
    
    Result of the DescribeSnapshots operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - describeSnapshots
```
DescribeSnapshotsResult describeSnapshots()
```
    Simplified method form for invoking the DescribeSnapshots operation.
    
    See Also:
    
    describeSnapshots(DescribeSnapshotsRequest)
  - listAllowedNodeTypeModifications
```
ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
```
    Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
    
    When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
    
    Parameters:
    
    listAllowedNodeTypeModificationsRequest - The input parameters for the ListAllowedNodeTypeModifications operation.
    
    Returns:
    
    Result of the ListAllowedNodeTypeModifications operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    See Also:
    
    AWS API Documentation
  - listAllowedNodeTypeModifications
```
ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
```
    Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
    
    See Also:
    
    listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.
    
    You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.
    
    Parameters:
    
    listTagsForResourceRequest - The input parameters for the ListTagsForResource operation.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheCluster
```
CacheCluster modifyCacheCluster(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.
    
    Parameters:
    
    modifyCacheClusterRequest - Represents the input of a ModifyCacheCluster operation.
    
    Returns:
    
    Result of the ModifyCacheCluster operation returned by the service.
    
    Throws:
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.
    
    InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
    
    NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidVPCNetworkStateException - The VPC network is in an invalid state.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheParameterGroup
```
ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
```
    Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
    
    Parameters:
    
    modifyCacheParameterGroupRequest - Represents the input of a ModifyCacheParameterGroup operation.
    
    Returns:
    
    Result of the ModifyCacheParameterGroup operation returned by the service.
    
    Throws:
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - modifyCacheSubnetGroup
```
CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
```
    Modifies an existing cache subnet group.
    
    Parameters:
    
    modifyCacheSubnetGroupRequest - Represents the input of a ModifyCacheSubnetGroup operation.
    
    Returns:
    
    Result of the ModifyCacheSubnetGroup operation returned by the service.
    
    Throws:
    
    CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.
    
    CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
    
    SubnetInUseException - The requested subnet is being used by another cache subnet group.
    
    InvalidSubnetException - An invalid subnet identifier was specified.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationGroup
```
ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
```
    Modifies the settings for a replication group.
    
    Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
    
    This operation is valid for Redis only.
    
    Parameters:
    
    modifyReplicationGroupRequest - Represents the input of a ModifyReplicationGroups operation.
    
    Returns:
    
    Result of the ModifyReplicationGroup operation returned by the service.
    
    Throws:
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.
    
    InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
    
    NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidVPCNetworkStateException - The VPC network is in an invalid state.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - modifyReplicationGroupShardConfiguration
```
ReplicationGroup modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
```
    Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime. Requires Redis engine version 3.2.10 or newer. For information on upgrading your engine to a newer version, see Upgrading Engine Versions in the Amazon ElastiCache User Guide.
    
    For more information on ElastiCache for Redis online horizontal scaling, see ElastiCache for Redis Horizontal Scaling
    
    Parameters:
    
    modifyReplicationGroupShardConfigurationRequest - Represents the input for a ModifyReplicationGroupShardConfiguration operation.
    
    Returns:
    
    Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
    
    Throws:
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    InvalidVPCNetworkStateException - The VPC network is in an invalid state.
    
    InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.
    
    NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 15
    
    NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - purchaseReservedCacheNodesOffering
```
ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
```
    Allows you to purchase a reserved cache node offering.
    
    Parameters:
    
    purchaseReservedCacheNodesOfferingRequest - Represents the input of a PurchaseReservedCacheNodesOffering operation.
    
    Returns:
    
    Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
    
    Throws:
    
    ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.
    
    ReservedCacheNodeAlreadyExistsException - You already have a reservation with the given identifier.
    
    ReservedCacheNodeQuotaExceededException - The request cannot be processed because it would exceed the user's cache node quota.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - rebootCacheCluster
```
CacheCluster rebootCacheCluster(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 (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.
    
    Parameters:
    
    rebootCacheClusterRequest - Represents the input of a RebootCacheCluster operation.
    
    Returns:
    
    Result of the RebootCacheCluster operation returned by the service.
    
    Throws:
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromResource
```
RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
```
    Removes the tags identified by the TagKeys list from the named resource.
    
    Parameters:
    
    removeTagsFromResourceRequest - Represents the input of a RemoveTagsFromResource operation.
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    Throws:
    
    CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.
    
    SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.
    
    InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.
    
    TagNotFoundException - The requested tag was not found on this resource.
    
    See Also:
    
    AWS API Documentation
  - resetCacheParameterGroup
```
ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
```
    Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
    
    Parameters:
    
    resetCacheParameterGroupRequest - Represents the input of a ResetCacheParameterGroup operation.
    
    Returns:
    
    Result of the ResetCacheParameterGroup operation returned by the service.
    
    Throws:
    
    InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.
    
    CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - revokeCacheSecurityGroupIngress
```
CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
```
    Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
    
    Parameters:
    
    revokeCacheSecurityGroupIngressRequest - Represents the input of a RevokeCacheSecurityGroupIngress operation.
    
    Returns:
    
    Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
    
    Throws:
    
    CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.
    
    AuthorizationNotFoundException - The specified Amazon EC2 security group is not authorized for the specified cache security group.
    
    InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - testFailover
```
ReplicationGroup testFailover(TestFailoverRequest testFailoverRequest)
```
    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).
    
    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 AWS 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 AWS 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 master node <primary-node-id> to replica node <node-id> completed
      
      Replication group message: Failover from master 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< /a> in the ElastiCache API Reference
    Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
    Parameters:
    
    testFailoverRequest -
    
    Returns:
    
    Result of the TestFailover operation returned by the service.
    
    Throws:
    
    APICallRateForCustomerExceededException - The customer has exceeded the allowed rate of API calls.
    
    InvalidCacheClusterStateException - The requested cluster is not in the available state.
    
    InvalidReplicationGroupStateException - The requested replication group is not in the available state.
    
    NodeGroupNotFoundException - The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.
    
    ReplicationGroupNotFoundException - The specified replication group does not exist.
    
    TestFailoverNotAvailableException
    
    InvalidParameterValueException - The value for a parameter is invalid.
    
    InvalidParameterCombinationException - Two or more incompatible parameters were specified.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AmazonElastiCacheWaiters waiters()
```

Did this page help you?

Interface AmazonElastiCache

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

addTagsToResource

authorizeCacheSecurityGroupIngress

copySnapshot

createCacheCluster

createCacheParameterGroup

createCacheSecurityGroup

createCacheSubnetGroup

createReplicationGroup

createSnapshot

deleteCacheCluster

deleteCacheParameterGroup

deleteCacheSecurityGroup

deleteCacheSubnetGroup

deleteReplicationGroup

deleteSnapshot

describeCacheClusters

describeCacheClusters

describeCacheEngineVersions

describeCacheEngineVersions

describeCacheParameterGroups

describeCacheParameterGroups

describeCacheParameters

describeCacheSecurityGroups

describeCacheSecurityGroups

describeCacheSubnetGroups

describeCacheSubnetGroups

describeEngineDefaultParameters

describeEvents

describeEvents

describeReplicationGroups

describeReplicationGroups

describeReservedCacheNodes

describeReservedCacheNodes

describeReservedCacheNodesOfferings

describeReservedCacheNodesOfferings

describeSnapshots

describeSnapshots

listAllowedNodeTypeModifications

listAllowedNodeTypeModifications

listTagsForResource

modifyCacheCluster

modifyCacheParameterGroup

modifyCacheSubnetGroup

modifyReplicationGroup

modifyReplicationGroupShardConfiguration

purchaseReservedCacheNodesOffering

rebootCacheCluster

removeTagsFromResource

resetCacheParameterGroup

revokeCacheSecurityGroupIngress

testFailover

shutdown

getCachedResponseMetadata

waiters