AmazonElastiCacheClient (AWS Java SDK for Amazon ElastiCache 1.9.23 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.elasticache.AmazonElastiCacheClient

All Implemented Interfaces:

AmazonElastiCache

Direct Known Subclasses:

AmazonElastiCacheAsyncClient
```
public class AmazonElastiCacheClient
extends AmazonWebServiceClient
implements AmazonElastiCache
```
Client for accessing AmazonElastiCache. All service calls made using this client are blocking, and will not return until the service call completes.
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 gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of 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
`protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>`	`exceptionUnmarshallers` List of exception unmarshallers for all AmazonElastiCache exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors
Constructor and Description
`AmazonElastiCacheClient()` Constructs a new client to invoke service methods on AmazonElastiCache.
`AmazonElastiCacheClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials.
`AmazonElastiCacheClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials and client configuration options.
`AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider.
`AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider and client configuration options.
`AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AmazonElastiCacheClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonElastiCache.

Method Summary

Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)` The AddTagsToResource action adds up to 10 cost allocation tags to the named resource.
`CacheSecurityGroup`	`authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)` The AuthorizeCacheSecurityGroupIngress action allows network ingress to a cache security group.
`Snapshot`	`copySnapshot(CopySnapshotRequest copySnapshotRequest)` The CopySnapshot action makes a copy of an existing snapshot.
`CacheCluster`	`createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)` The CreateCacheCluster action creates a cache cluster.
`CacheParameterGroup`	`createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)` The CreateCacheParameterGroup action creates a new cache parameter group.
`CacheSecurityGroup`	`createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)` The CreateCacheSecurityGroup action creates a new cache security group.
`CacheSubnetGroup`	`createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)` The CreateCacheSubnetGroup action creates a new cache subnet group.
`ReplicationGroup`	`createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)` The CreateReplicationGroup action creates a replication group.
`Snapshot`	`createSnapshot(CreateSnapshotRequest createSnapshotRequest)` The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
`CacheCluster`	`deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)` The DeleteCacheCluster action deletes a previously provisioned cache cluster.
`void`	`deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)` The DeleteCacheParameterGroup action deletes the specified cache parameter group.
`void`	`deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)` The DeleteCacheSecurityGroup action deletes a cache security group.
`void`	`deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)` The DeleteCacheSubnetGroup action deletes a cache subnet group.
`ReplicationGroup`	`deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)` The DeleteReplicationGroup action deletes an existing replication group.
`Snapshot`	`deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)` The DeleteSnapshot action deletes an existing snapshot.
`DescribeCacheClustersResult`	`describeCacheClusters()` The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
`DescribeCacheClustersResult`	`describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)` The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
`DescribeCacheEngineVersionsResult`	`describeCacheEngineVersions()` The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
`DescribeCacheEngineVersionsResult`	`describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)` The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups()` The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions.
`DescribeCacheParameterGroupsResult`	`describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)` The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions.
`DescribeCacheParametersResult`	`describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)` The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups()` The DescribeCacheSecurityGroups action returns a list of cache security group descriptions.
`DescribeCacheSecurityGroupsResult`	`describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)` The DescribeCacheSecurityGroups action returns a list of cache security group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups()` The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions.
`DescribeCacheSubnetGroupsResult`	`describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)` The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions.
`EngineDefaults`	`describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)` The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
`DescribeEventsResult`	`describeEvents()` The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest describeEventsRequest)` The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups.
`DescribeReplicationGroupsResult`	`describeReplicationGroups()` The DescribeReplicationGroups action returns information about a particular replication group.
`DescribeReplicationGroupsResult`	`describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)` The DescribeReplicationGroups action returns information about a particular replication group.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes()` The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesResult`	`describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)` The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings()` The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
`DescribeReservedCacheNodesOfferingsResult`	`describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)` The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
`DescribeSnapshotsResult`	`describeSnapshots()` The DescribeSnapshots action returns information about cache cluster snapshots.
`DescribeSnapshotsResult`	`describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)` The DescribeSnapshots action returns information about cache cluster 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.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` The ListTagsForResource action lists all cost allocation tags currently on the named resource.
`CacheCluster`	`modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)` The ModifyCacheCluster action modifies the settings for a cache cluster.
`ModifyCacheParameterGroupResult`	`modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)` The ModifyCacheParameterGroup action modifies the parameters of a cache parameter group.
`CacheSubnetGroup`	`modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)` The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
`ReplicationGroup`	`modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)` The ModifyReplicationGroup action modifies the settings for a replication group.
`ReservedCacheNode`	`purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)` The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
`CacheCluster`	`rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)` The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)` The RemoveTagsFromResource action removes the tags identified by the `TagKeys` list from the named resource.
`ResetCacheParameterGroupResult`	`resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)` The ResetCacheParameterGroup action modifies the parameters of a cache parameter group to the engine or system default value.
`CacheSecurityGroup`	`revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)` The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group.

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

Methods inherited from interface com.amazonaws.services.elasticache.AmazonElastiCache
setEndpoint, setRegion, shutdown

- Field Detail
  - exceptionUnmarshallers
```
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
```
    List of exception unmarshallers for all AmazonElastiCache exceptions.
- Constructor Detail
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient()
```
    Constructs a new client to invoke service methods on AmazonElastiCache. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonElastiCache. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to AmazonElastiCache (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AmazonElastiCache (ex: proxy settings, retry counts, etc.).
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AmazonElastiCache (ex: proxy settings, retry counts, etc.).
  - AmazonElastiCacheClient
```
public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       RequestMetricCollector requestMetricCollector)
```
    Constructs a new client to invoke service methods on AmazonElastiCache using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to AmazonElastiCache (ex: proxy settings, retry counts, etc.).
    requestMetricCollector - optional request metric collector
- Method Detail
  - describeEngineDefaultParameters
```
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
```
    The DescribeEngineDefaultParameters action returns the default engine and system parameter information for the specified cache engine.
    
    Specified by:
    
    describeEngineDefaultParameters in interface AmazonElastiCache
    
    Parameters:
    describeEngineDefaultParametersRequest - Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeEngineDefaultParameters service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteCacheCluster
```
public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
```
    The DeleteCacheCluster action deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.
    
    This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.
    
    Specified by:
    
    deleteCacheCluster in interface AmazonElastiCache
    
    Parameters:
    deleteCacheClusterRequest - Container for the necessary parameters to execute the DeleteCacheCluster service method on AmazonElastiCache.
    
    Returns:
    The response from the DeleteCacheCluster service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    SnapshotFeatureNotSupportedException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    InvalidCacheClusterStateException
    
    SnapshotAlreadyExistsException
    
    SnapshotQuotaExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReservedCacheNodes
```
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
```
    The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
    
    Specified by:
    
    describeReservedCacheNodes in interface AmazonElastiCache
    
    Parameters:
    describeReservedCacheNodesRequest - Container for the necessary parameters to execute the DescribeReservedCacheNodes service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.
    
    Throws:
    
    ReservedCacheNodeNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteReplicationGroup
```
public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
```
    The DeleteReplicationGroup action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.
    
    When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.
    
    Specified by:
    
    deleteReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    deleteReplicationGroupRequest - Container for the necessary parameters to execute the DeleteReplicationGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the DeleteReplicationGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidReplicationGroupStateException
    
    InvalidParameterValueException
    
    SnapshotFeatureNotSupportedException
    
    ReplicationGroupNotFoundException
    
    InvalidParameterCombinationException
    
    SnapshotAlreadyExistsException
    
    SnapshotQuotaExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteSnapshot
```
public Snapshot deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
```
    The DeleteSnapshot action deletes an existing snapshot. When you receive a successful response from this action, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this action.
    
    Specified by:
    
    deleteSnapshot in interface AmazonElastiCache
    
    Parameters:
    deleteSnapshotRequest - Container for the necessary parameters to execute the DeleteSnapshot service method on AmazonElastiCache.
    
    Returns:
    The response from the DeleteSnapshot service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidSnapshotStateException
    
    InvalidParameterValueException
    
    SnapshotNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createCacheSubnetGroup
```
public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
```
    The CreateCacheSubnetGroup action creates a new cache subnet group.
    
    Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).
    
    Specified by:
    
    createCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    createCacheSubnetGroupRequest - Container for the necessary parameters to execute the CreateCacheSubnetGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateCacheSubnetGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheSubnetGroupAlreadyExistsException
    
    CacheSubnetGroupQuotaExceededException
    
    CacheSubnetQuotaExceededException
    
    InvalidSubnetException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteCacheSubnetGroup
```
public void deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
```
    The DeleteCacheSubnetGroup action deletes a cache subnet group.
    
    NOTE:You cannot delete a cache subnet group if it is associated with any cache clusters.
    
    Specified by:
    
    deleteCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    deleteCacheSubnetGroupRequest - Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method on AmazonElastiCache.
    
    Throws:
    
    CacheSubnetGroupNotFoundException
    
    CacheSubnetGroupInUseException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheParameters
```
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
```
    The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.
    
    Specified by:
    
    describeCacheParameters in interface AmazonElastiCache
    
    Parameters:
    describeCacheParametersRequest - Container for the necessary parameters to execute the DescribeCacheParameters service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheParameters service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    The ListTagsForResource action 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. Cost allocation tags can be used to categorize and track your AWS costs.
    
    You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache .
    
    Specified by:
    
    listTagsForResource in interface AmazonElastiCache
    
    Parameters:
    listTagsForResourceRequest - Container for the necessary parameters to execute the ListTagsForResource service method on AmazonElastiCache.
    
    Returns:
    The response from the ListTagsForResource service method, as returned by AmazonElastiCache.
    
    Throws:
    
    SnapshotNotFoundException
    
    CacheClusterNotFoundException
    
    InvalidARNException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteCacheSecurityGroup
```
public void deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
```
    The DeleteCacheSecurityGroup action deletes a cache security group.
    
    NOTE:You cannot delete a cache security group if it is associated with any cache clusters.
    
    Specified by:
    
    deleteCacheSecurityGroup in interface AmazonElastiCache
    
    Parameters:
    deleteCacheSecurityGroupRequest - Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method on AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidCacheSecurityGroupStateException
    
    InvalidParameterCombinationException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - addTagsToResource
```
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
```
    The AddTagsToResource action adds up to 10 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. Cost allocation tags can be used 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 .
    
    Specified by:
    
    addTagsToResource in interface AmazonElastiCache
    
    Parameters:
    addTagsToResourceRequest - Container for the necessary parameters to execute the AddTagsToResource service method on AmazonElastiCache.
    
    Returns:
    The response from the AddTagsToResource service method, as returned by AmazonElastiCache.
    
    Throws:
    
    SnapshotNotFoundException
    
    TagQuotaPerResourceExceededException
    
    CacheClusterNotFoundException
    
    InvalidARNException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - copySnapshot
```
public Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest)
```
    The CopySnapshot action makes a copy of an existing snapshot.
    
    Specified by:
    
    copySnapshot in interface AmazonElastiCache
    
    Parameters:
    copySnapshotRequest - Container for the necessary parameters to execute the CopySnapshot service method on AmazonElastiCache.
    
    Returns:
    The response from the CopySnapshot service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidSnapshotStateException
    
    InvalidParameterValueException
    
    SnapshotNotFoundException
    
    InvalidParameterCombinationException
    
    SnapshotAlreadyExistsException
    
    SnapshotQuotaExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
```
    The DescribeSnapshots action returns information about cache cluster 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.
    
    Specified by:
    
    describeSnapshots in interface AmazonElastiCache
    
    Parameters:
    describeSnapshotsRequest - Container for the necessary parameters to execute the DescribeSnapshots service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    SnapshotNotFoundException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheSecurityGroups
```
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
```
    The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
    
    Specified by:
    
    describeCacheSecurityGroups in interface AmazonElastiCache
    
    Parameters:
    describeCacheSecurityGroupsRequest - Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - revokeCacheSecurityGroupIngress
```
public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
```
    The RevokeCacheSecurityGroupIngress action revokes ingress from a cache security group. Use this action to disallow access from an Amazon EC2 security group that had been previously authorized.
    
    Specified by:
    
    revokeCacheSecurityGroupIngress in interface AmazonElastiCache
    
    Parameters:
    revokeCacheSecurityGroupIngressRequest - Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method on AmazonElastiCache.
    
    Returns:
    The response from the RevokeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidCacheSecurityGroupStateException
    
    AuthorizationNotFoundException
    
    InvalidParameterCombinationException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createReplicationGroup
```
public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
```
    The CreateReplicationGroup action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.
    
    When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.
    
    Note: This action is valid only for Redis.
    
    Specified by:
    
    createReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    createReplicationGroupRequest - Container for the necessary parameters to execute the CreateReplicationGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateReplicationGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    NodeQuotaForCustomerExceededException
    
    ClusterQuotaForCustomerExceededException
    
    TagQuotaPerResourceExceededException
    
    InsufficientCacheClusterCapacityException
    
    InvalidParameterCombinationException
    
    CacheClusterNotFoundException
    
    CacheParameterGroupNotFoundException
    
    InvalidCacheClusterStateException
    
    CacheSecurityGroupNotFoundException
    
    ReplicationGroupAlreadyExistsException
    
    NodeQuotaForClusterExceededException
    
    CacheSubnetGroupNotFoundException
    
    InvalidParameterValueException
    
    InvalidVPCNetworkStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - removeTagsFromResource
```
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
```
    The RemoveTagsFromResource action removes the tags identified by the TagKeys list from the named resource.
    
    Specified by:
    
    removeTagsFromResource in interface AmazonElastiCache
    
    Parameters:
    removeTagsFromResourceRequest - Container for the necessary parameters to execute the RemoveTagsFromResource service method on AmazonElastiCache.
    
    Returns:
    The response from the RemoveTagsFromResource service method, as returned by AmazonElastiCache.
    
    Throws:
    
    TagNotFoundException
    
    SnapshotNotFoundException
    
    CacheClusterNotFoundException
    
    InvalidARNException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createCacheCluster
```
public CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
```
    The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
    
    Specified by:
    
    createCacheCluster in interface AmazonElastiCache
    
    Parameters:
    createCacheClusterRequest - Container for the necessary parameters to execute the CreateCacheCluster service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateCacheCluster service method, as returned by AmazonElastiCache.
    
    Throws:
    
    NodeQuotaForCustomerExceededException
    
    ClusterQuotaForCustomerExceededException
    
    CacheClusterAlreadyExistsException
    
    TagQuotaPerResourceExceededException
    
    InsufficientCacheClusterCapacityException
    
    InvalidParameterCombinationException
    
    ReplicationGroupNotFoundException
    
    CacheParameterGroupNotFoundException
    
    CacheSecurityGroupNotFoundException
    
    NodeQuotaForClusterExceededException
    
    CacheSubnetGroupNotFoundException
    
    InvalidReplicationGroupStateException
    
    InvalidParameterValueException
    
    InvalidVPCNetworkStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheEngineVersions
```
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
```
    The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
    
    Specified by:
    
    describeCacheEngineVersions in interface AmazonElastiCache
    
    Parameters:
    describeCacheEngineVersionsRequest - Container for the necessary parameters to execute the DescribeCacheEngineVersions service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.
    
    Throws:
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - modifyCacheSubnetGroup
```
public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
```
    The ModifyCacheSubnetGroup action modifies an existing cache subnet group.
    
    Specified by:
    
    modifyCacheSubnetGroup in interface AmazonElastiCache
    
    Parameters:
    modifyCacheSubnetGroupRequest - Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the ModifyCacheSubnetGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheSubnetGroupNotFoundException
    
    CacheSubnetQuotaExceededException
    
    InvalidSubnetException
    
    SubnetInUseException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - deleteCacheParameterGroup
```
public void deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
```
    The DeleteCacheParameterGroup action deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
    
    Specified by:
    
    deleteCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    deleteCacheParameterGroupRequest - Container for the necessary parameters to execute the DeleteCacheParameterGroup service method on AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    InvalidCacheParameterGroupStateException
    
    CacheParameterGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createSnapshot
```
public Snapshot createSnapshot(CreateSnapshotRequest createSnapshotRequest)
```
    The CreateSnapshot action creates a copy of an entire cache cluster at a specific moment in time.
    
    Specified by:
    
    createSnapshot in interface AmazonElastiCache
    
    Parameters:
    createSnapshotRequest - Container for the necessary parameters to execute the CreateSnapshot service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateSnapshot service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    SnapshotFeatureNotSupportedException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    SnapshotAlreadyExistsException
    
    InvalidCacheClusterStateException
    
    SnapshotQuotaExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
```
    The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache 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:
    describeEventsRequest - Container for the necessary parameters to execute the DescribeEvents service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeEvents service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - authorizeCacheSecurityGroupIngress
```
public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
```
    The AuthorizeCacheSecurityGroupIngress action 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.
    
    NOTE: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:
    authorizeCacheSecurityGroupIngressRequest - Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method on AmazonElastiCache.
    
    Returns:
    The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    AuthorizationAlreadyExistsException
    
    InvalidCacheSecurityGroupStateException
    
    InvalidParameterCombinationException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - purchaseReservedCacheNodesOffering
```
public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
```
    The PurchaseReservedCacheNodesOffering action allows you to purchase a reserved cache node offering.
    
    Specified by:
    
    purchaseReservedCacheNodesOffering in interface AmazonElastiCache
    
    Parameters:
    purchaseReservedCacheNodesOfferingRequest - Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method on AmazonElastiCache.
    
    Returns:
    The response from the PurchaseReservedCacheNodesOffering service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    ReservedCacheNodeQuotaExceededException
    
    ReservedCacheNodeAlreadyExistsException
    
    ReservedCacheNodesOfferingNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - modifyReplicationGroup
```
public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
```
    The ModifyReplicationGroup action modifies the settings for a replication group.
    
    Specified by:
    
    modifyReplicationGroup in interface AmazonElastiCache
    
    Parameters:
    modifyReplicationGroupRequest - Container for the necessary parameters to execute the ModifyReplicationGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the ModifyReplicationGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    NodeQuotaForCustomerExceededException
    
    InsufficientCacheClusterCapacityException
    
    ReplicationGroupNotFoundException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    InvalidCacheClusterStateException
    
    CacheSecurityGroupNotFoundException
    
    NodeQuotaForClusterExceededException
    
    InvalidReplicationGroupStateException
    
    InvalidParameterValueException
    
    InvalidCacheSecurityGroupStateException
    
    InvalidVPCNetworkStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReplicationGroups
```
public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
```
    The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
    
    Specified by:
    
    describeReplicationGroups in interface AmazonElastiCache
    
    Parameters:
    describeReplicationGroupsRequest - Container for the necessary parameters to execute the DescribeReplicationGroups service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    ReplicationGroupNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - modifyCacheParameterGroup
```
public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
```
    The ModifyCacheParameterGroup action 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:
    modifyCacheParameterGroupRequest - Container for the necessary parameters to execute the ModifyCacheParameterGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the ModifyCacheParameterGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    InvalidCacheParameterGroupStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReservedCacheNodesOfferings
```
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
```
    The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
    
    Specified by:
    
    describeReservedCacheNodesOfferings in interface AmazonElastiCache
    
    Parameters:
    describeReservedCacheNodesOfferingsRequest - Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    ReservedCacheNodesOfferingNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - modifyCacheCluster
```
public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
```
    The ModifyCacheCluster action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
    
    Specified by:
    
    modifyCacheCluster in interface AmazonElastiCache
    
    Parameters:
    modifyCacheClusterRequest - Container for the necessary parameters to execute the ModifyCacheCluster service method on AmazonElastiCache.
    
    Returns:
    The response from the ModifyCacheCluster service method, as returned by AmazonElastiCache.
    
    Throws:
    
    NodeQuotaForCustomerExceededException
    
    NodeQuotaForClusterExceededException
    
    InvalidParameterValueException
    
    InvalidCacheSecurityGroupStateException
    
    InvalidVPCNetworkStateException
    
    InsufficientCacheClusterCapacityException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    InvalidCacheClusterStateException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - resetCacheParameterGroup
```
public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
```
    The ResetCacheParameterGroup action 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:
    resetCacheParameterGroupRequest - Container for the necessary parameters to execute the ResetCacheParameterGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the ResetCacheParameterGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    InvalidCacheParameterGroupStateException
    
    CacheParameterGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheClusters
```
public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
```
    The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
    
    By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache 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 will be displayed until all of the nodes are successfully provisioned.
    
    If the cluster is in the DELETING state, only cluster level information will be displayed.
    
    If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.
    
    If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
    
    Specified by:
    
    describeCacheClusters in interface AmazonElastiCache
    
    Parameters:
    describeCacheClustersRequest - Container for the necessary parameters to execute the DescribeCacheClusters service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createCacheSecurityGroup
```
public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
```
    The CreateCacheSecurityGroup action creates a new cache security group. Use a cache security group to control access to one or more cache clusters.
    
    Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup .
    
    Specified by:
    
    createCacheSecurityGroup in interface AmazonElastiCache
    
    Parameters:
    createCacheSecurityGroupRequest - Container for the necessary parameters to execute the CreateCacheSecurityGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateCacheSecurityGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheSecurityGroupAlreadyExistsException
    
    InvalidParameterValueException
    
    CacheSecurityGroupQuotaExceededException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheSubnetGroups
```
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
```
    The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
    
    Specified by:
    
    describeCacheSubnetGroups in interface AmazonElastiCache
    
    Parameters:
    describeCacheSubnetGroupsRequest - Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheSubnetGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheParameterGroups
```
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
```
    The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
    
    Specified by:
    
    describeCacheParameterGroups in interface AmazonElastiCache
    
    Parameters:
    describeCacheParameterGroupsRequest - Container for the necessary parameters to execute the DescribeCacheParameterGroups service method on AmazonElastiCache.
    
    Returns:
    The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - rebootCacheCluster
```
public CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
```
    The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache 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 cache cluster event is created.
    
    Specified by:
    
    rebootCacheCluster in interface AmazonElastiCache
    
    Parameters:
    rebootCacheClusterRequest - Container for the necessary parameters to execute the RebootCacheCluster service method on AmazonElastiCache.
    
    Returns:
    The response from the RebootCacheCluster service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheClusterNotFoundException
    
    InvalidCacheClusterStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - createCacheParameterGroup
```
public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
```
    The CreateCacheParameterGroup action creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.
    
    Specified by:
    
    createCacheParameterGroup in interface AmazonElastiCache
    
    Parameters:
    createCacheParameterGroupRequest - Container for the necessary parameters to execute the CreateCacheParameterGroup service method on AmazonElastiCache.
    
    Returns:
    The response from the CreateCacheParameterGroup service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    CacheParameterGroupQuotaExceededException
    
    CacheParameterGroupAlreadyExistsException
    
    InvalidParameterCombinationException
    
    InvalidCacheParameterGroupStateException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReservedCacheNodes
```
public DescribeReservedCacheNodesResult describeReservedCacheNodes()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException
```
    The DescribeReservedCacheNodes action returns information about reserved cache nodes for this account, or about a specified reserved cache node.
    
    Specified by:
    
    describeReservedCacheNodes in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.
    
    Throws:
    
    ReservedCacheNodeNotFoundException
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeSnapshots
```
public DescribeSnapshotsResult describeSnapshots()
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    The DescribeSnapshots action returns information about cache cluster 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.
    
    Specified by:
    
    describeSnapshots in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    SnapshotNotFoundException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheSecurityGroups
```
public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    The DescribeCacheSecurityGroups action returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.
    
    Specified by:
    
    describeCacheSecurityGroups in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheSecurityGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheEngineVersions
```
public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException
```
    The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
    
    Specified by:
    
    describeCacheEngineVersions in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.
    
    Throws:
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeEvents
```
public DescribeEventsResult describeEvents()
                                    throws AmazonServiceException,
                                           AmazonClientException
```
    The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache 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
    
    Returns:
    The response from the DescribeEvents service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReplicationGroups
```
public DescribeReplicationGroupsResult describeReplicationGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    The DescribeReplicationGroups action returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
    
    Specified by:
    
    describeReplicationGroups in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    ReplicationGroupNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeReservedCacheNodesOfferings
```
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException
```
    The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
    
    Specified by:
    
    describeReservedCacheNodesOfferings in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    ReservedCacheNodesOfferingNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheClusters
```
public DescribeCacheClustersResult describeCacheClusters()
                                                  throws AmazonServiceException,
                                                         AmazonClientException
```
    The DescribeCacheClusters action returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
    
    By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache 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 will be displayed until all of the nodes are successfully provisioned.
    
    If the cluster is in the DELETING state, only cluster level information will be displayed.
    
    If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.
    
    If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
    
    Specified by:
    
    describeCacheClusters in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    CacheClusterNotFoundException
    
    InvalidParameterCombinationException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheSubnetGroups
```
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    The DescribeCacheSubnetGroups action returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
    
    Specified by:
    
    describeCacheSubnetGroups in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    CacheSubnetGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - describeCacheParameterGroups
```
public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.
    
    Specified by:
    
    describeCacheParameterGroups in interface AmazonElastiCache
    
    Returns:
    The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.
    
    Throws:
    
    InvalidParameterValueException
    
    InvalidParameterCombinationException
    
    CacheParameterGroupNotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by AmazonElastiCache indicating either a problem with the data in the request, or a server side issue.
  - getCachedResponseMetadata
```
public 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 the 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.

Class AmazonElastiCacheClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Field Detail

exceptionUnmarshallers

Constructor Detail

AmazonElastiCacheClient

AmazonElastiCacheClient

AmazonElastiCacheClient

AmazonElastiCacheClient

AmazonElastiCacheClient

AmazonElastiCacheClient

AmazonElastiCacheClient

Method Detail

describeEngineDefaultParameters

deleteCacheCluster

describeReservedCacheNodes

deleteReplicationGroup

deleteSnapshot

createCacheSubnetGroup

deleteCacheSubnetGroup

describeCacheParameters

listTagsForResource

deleteCacheSecurityGroup

addTagsToResource

copySnapshot

describeSnapshots

describeCacheSecurityGroups

revokeCacheSecurityGroupIngress

createReplicationGroup

removeTagsFromResource

createCacheCluster

describeCacheEngineVersions

modifyCacheSubnetGroup

deleteCacheParameterGroup

createSnapshot

describeEvents

authorizeCacheSecurityGroupIngress

purchaseReservedCacheNodesOffering

modifyReplicationGroup

describeReplicationGroups

modifyCacheParameterGroup

describeReservedCacheNodesOfferings

modifyCacheCluster

resetCacheParameterGroup

describeCacheClusters

createCacheSecurityGroup

describeCacheSubnetGroups

describeCacheParameterGroups

rebootCacheCluster

createCacheParameterGroup

describeReservedCacheNodes

describeSnapshots

describeCacheSecurityGroups

describeCacheEngineVersions

describeEvents

describeReplicationGroups

describeReservedCacheNodesOfferings

describeCacheClusters

describeCacheSubnetGroups

describeCacheParameterGroups

getCachedResponseMetadata