com.amazonaws.services.elasticache
Interface AmazonElastiCache

All Known Subinterfaces:

AmazonElastiCacheAsync

All Known Implementing Classes:

AmazonElastiCacheAsyncClient, AmazonElastiCacheClient

public interface AmazonElastiCache

Interface for accessing AmazonElastiCache. 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 Amazon 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 set-up, 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.

Method Summary

CacheSecurityGroup	authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters).
CacheCluster	createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) Creates a new Cache Cluster.
CacheParameterGroup	createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) Creates a new Cache Parameter Group.
CacheSecurityGroup	createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) Creates a new Cache Security Group.
CacheSubnetGroup	createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) Creates a new Cache Subnet Group.
CacheCluster	deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) Deletes a previously provisioned Cache Cluster.
void	deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) Deletes the specified CacheParameterGroup.
void	deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) Deletes a Cache Security Group.
void	deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) Deletes a Cache Subnet Group.
DescribeCacheClustersResult	describeCacheClusters() 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) 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() Returns a list of the available cache engines and their versions.
DescribeCacheEngineVersionsResult	describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) Returns a list of the available cache engines and their versions.
DescribeCacheParameterGroupsResult	describeCacheParameterGroups() Returns a list of CacheParameterGroup descriptions.
DescribeCacheParameterGroupsResult	describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) Returns a list of CacheParameterGroup descriptions.
DescribeCacheParametersResult	describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) Returns the detailed parameter list for a particular CacheParameterGroup.
DescribeCacheSecurityGroupsResult	describeCacheSecurityGroups() Returns a list of CacheSecurityGroup descriptions.
DescribeCacheSecurityGroupsResult	describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) Returns a list of CacheSecurityGroup descriptions.
DescribeCacheSubnetGroupsResult	describeCacheSubnetGroups() Returns a list of CacheSubnetGroup descriptions.
DescribeCacheSubnetGroupsResult	describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) Returns a list of CacheSubnetGroup descriptions.
EngineDefaults	describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified cache engine.
DescribeEventsResult	describeEvents() Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days.
DescribeReservedCacheNodesResult	describeReservedCacheNodes() Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.
DescribeReservedCacheNodesResult	describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.
DescribeReservedCacheNodesOfferingsResult	describeReservedCacheNodesOfferings() Lists available reserved Cache Node offerings.
DescribeReservedCacheNodesOfferingsResult	describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) Lists available reserved Cache Node offerings.
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.
CacheCluster	modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) Modifies the Cache Cluster settings.
ModifyCacheParameterGroupResult	modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) Modifies the parameters of a CacheParameterGroup.
CacheSubnetGroup	modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) Modifies an existing Cache Subnet Group.
ReservedCacheNode	purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) Purchases a reserved Cache Node offering.
CacheCluster	rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster.
ResetCacheParameterGroupResult	resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) Modifies the parameters of a CacheParameterGroup to the engine or system default value.
CacheSecurityGroup	revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://elasticache.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://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: "https://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: "https://elasticache.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

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.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

authorizeCacheSecurityGroupIngress

CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Authorizes ingress to a CacheSecurityGroup using EC2 Security Groups as authorization (therefore the application using the cache must be running on EC2 clusters). This API requires the following parameters: EC2SecurityGroupName and EC2SecurityGroupOwnerId.

NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon Cache Cluster in another.

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.

createCacheSubnetGroup

CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates a new Cache Subnet Group.

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.

purchaseReservedCacheNodesOffering

ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Purchases a reserved Cache Node offering.

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.

rebootCacheCluster

CacheCluster rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Reboots some (or all) of the cache cluster nodes within a previously provisioned ElastiCache cluster. This API results in the application of modified CacheParameterGroup parameters to the cache cluster. This action is taken as soon as possible, and results in a momentary outage to the cache cluster during which the cache cluster status is set to rebooting. During that momentary outage, the contents of the cache (for each cache cluster node being rebooted) are lost. A CacheCluster event is created when the reboot is completed.

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.

revokeCacheSecurityGroupIngress

CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Revokes ingress from a CacheSecurityGroup for previously authorized EC2 Security Groups.

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.

describeCacheSubnetGroups

DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group.

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.

createCacheSecurityGroup

CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Creates a new Cache Security Group. Cache Security groups control access to one or more Cache Clusters.

Only use cache security groups when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). Inside of a VPC, use VPC security groups.

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.

createCacheCluster

CacheCluster createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Creates a new Cache Cluster.

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

NodeQuotaForClusterExceededException

CacheSubnetGroupNotFoundException

InvalidParameterValueException

ClusterQuotaForCustomerExceededException

CacheClusterAlreadyExistsException

InvalidVPCNetworkStateException

InsufficientCacheClusterCapacityException

InvalidParameterCombinationException

CacheParameterGroupNotFoundException

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.

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

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.

describeReservedCacheNodes

DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.

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.

describeCacheEngineVersions

DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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

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.

deleteCacheParameterGroup

void deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes the specified CacheParameterGroup. The CacheParameterGroup cannot be deleted if it is associated with any cache clusters.

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.

modifyCacheParameterGroup

ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Modifies the parameters of a CacheParameterGroup. To modify more than one parameter, submit a list of ParameterName and ParameterValue parameters. A maximum of 20 parameters can be modified in a single request.

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.

describeEngineDefaultParameters

EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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

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.

deleteCacheSubnetGroup

void deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a Cache Subnet Group.

NOTE:The specified Cache Subnet Group must not be associated with any Cache Clusters.

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.

createCacheParameterGroup

CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Creates a new Cache Parameter Group. Cache Parameter groups control the parameters for a Cache Cluster.

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.

describeCacheSecurityGroups

DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup.

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.

describeCacheParameterGroups

DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.

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.

describeCacheClusters

DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.

While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.

While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.

DescribeCacheClusters supports pagination.

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.

resetCacheParameterGroup

ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Modifies the parameters of a CacheParameterGroup to the engine or system default value. To reset specific parameters submit a list of the parameter names. To reset the entire CacheParameterGroup, specify the CacheParameterGroup name and ResetAllParameters parameters.

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.

deleteCacheSecurityGroup

void deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deletes a Cache Security Group.

NOTE:The specified Cache Security Group must not be associated with any Cache Clusters.

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.

modifyCacheCluster

CacheCluster modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Modifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request.

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

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.

deleteCacheCluster

CacheCluster deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Deletes a previously provisioned Cache Cluster. A successful response from the web service indicates the request was received correctly. This action cannot be canceled or reverted. DeleteCacheCluster deletes all associated Cache Nodes, node endpoints and the Cache Cluster itself.

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

CacheClusterNotFoundException

InvalidParameterCombinationException

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.

describeReservedCacheNodesOfferings

DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Lists available reserved Cache Node offerings.

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.

describeCacheParameters

DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns the detailed parameter list for a particular CacheParameterGroup.

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.

modifyCacheSubnetGroup

CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Modifies an existing Cache Subnet Group.

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.

describeCacheSubnetGroups

DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a list of CacheSubnetGroup descriptions. If a CacheSubnetGroupName is specified, the list will contain only the description of the specified Cache Subnet Group.

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.

describeEvents

DescribeEventsResult describeEvents()
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns events related to Cache Clusters, Cache Security Groups, and Cache Parameter Groups for the past 14 days. Events specific to a particular Cache Cluster, Cache Security Group, or Cache Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

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.

describeReservedCacheNodes

DescribeReservedCacheNodesResult describeReservedCacheNodes()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.

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.

describeCacheEngineVersions

DescribeCacheEngineVersionsResult describeCacheEngineVersions()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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

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.

describeCacheSecurityGroups

DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns a list of CacheSecurityGroup descriptions. If a CacheSecurityGroupName is specified, the list will contain only the description of the specified CacheSecurityGroup.

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.

describeCacheParameterGroups

DescribeCacheParameterGroupsResult describeCacheParameterGroups()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.

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.

describeCacheClusters

DescribeCacheClustersResult describeCacheClusters()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.

While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.

While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.

DescribeCacheClusters supports pagination.

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.

describeReservedCacheNodesOfferings

DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Lists available reserved Cache Node offerings.

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.

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.