com.amazonaws.services.elasticache

Class AmazonElastiCacheClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticache.AmazonElastiCacheClient

All Implemented Interfaces:

AmazonElastiCache

Direct Known Subclasses:

AmazonElastiCacheAsyncClient

@ThreadSafe
public class AmazonElastiCacheClient
extends AmazonWebServiceClient
implements AmazonElastiCache

Client for accessing Amazon ElastiCache. 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 static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all modeled 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 Amazon ElastiCache.
AmazonElastiCacheClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account credentials.
AmazonElastiCacheClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account credentials and client configuration options.
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon ElastiCache using the specified AWS account credentials provider.
AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon ElastiCache 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 Amazon ElastiCache 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 Amazon ElastiCache.

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.
DeleteCacheParameterGroupResult	deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) The DeleteCacheParameterGroup action deletes the specified cache parameter group.
DeleteCacheSecurityGroupResult	deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) The DeleteCacheSecurityGroup action deletes a cache security group.
DeleteCacheSubnetGroupResult	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() Simplified method form for invoking the DescribeCacheClusters operation.
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() Simplified method form for invoking the DescribeCacheEngineVersions operation.
DescribeCacheEngineVersionsResult	describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.
DescribeCacheParameterGroupsResult	describeCacheParameterGroups() Simplified method form for invoking the DescribeCacheParameterGroups operation.
DescribeCacheParameterGroupsResult	describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) 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() Simplified method form for invoking the DescribeCacheSecurityGroups operation.
DescribeCacheSecurityGroupsResult	describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) The DescribeCacheSecurityGroups action returns a list of cache security group descriptions.
DescribeCacheSubnetGroupsResult	describeCacheSubnetGroups() Simplified method form for invoking the DescribeCacheSubnetGroups operation.
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() Simplified method form for invoking the DescribeEvents operation.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) The DescribeEvents action returns events related to cache clusters, cache security groups, and cache parameter groups.
DescribeReplicationGroupsResult	describeReplicationGroups() Simplified method form for invoking the DescribeReplicationGroups operation.
DescribeReplicationGroupsResult	describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) The DescribeReplicationGroups action returns information about a particular replication group.
DescribeReservedCacheNodesResult	describeReservedCacheNodes() Simplified method form for invoking the DescribeReservedCacheNodes operation.
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() Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
DescribeReservedCacheNodesOfferingsResult	describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.
DescribeSnapshotsResult	describeSnapshots() Simplified method form for invoking the DescribeSnapshots operation.
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.
ListAllowedNodeTypeModificationsResult	listAllowedNodeTypeModifications() Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
ListAllowedNodeTypeModificationsResult	listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) The ListAllowedNodeTypeModifications action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

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

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all modeled exceptions

Constructor Detail

AmazonElastiCacheClient

public AmazonElastiCacheClient()

Constructs a new client to invoke service methods on Amazon ElastiCache. 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 Amazon ElastiCache. 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 Amazon ElastiCache (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonElastiCacheClient

public AmazonElastiCacheClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Amazon ElastiCache 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 Amazon ElastiCache 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 Amazon ElastiCache (ex: proxy settings, retry counts, etc.).

AmazonElastiCacheClient

public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Amazon ElastiCache 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 Amazon ElastiCache 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 Amazon ElastiCache (ex: proxy settings, retry counts, etc.).

AmazonElastiCacheClient

public AmazonElastiCacheClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Amazon ElastiCache 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 Amazon ElastiCache (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

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 - Represents the input of an AddTagsToResource action.

Returns:

Result of the AddTagsToResource operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10.

InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

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.

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 - Represents the input of an AuthorizeCacheSecurityGroupIngress action.

Returns:

Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.

Throws:

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.

AuthorizationAlreadyExistsException - The specified Amazon EC2 security group is already authorized for the specified cache security group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

copySnapshot

public Snapshot copySnapshot(CopySnapshotRequest copySnapshotRequest)

The CopySnapshot action makes a copy of an existing snapshot.

Specified by:

copySnapshot in interface AmazonElastiCache

Parameters:

copySnapshotRequest - Represents the input of a CopySnapshotMessage action.

Returns:

Result of the CopySnapshot operation returned by the service.

Throws:

SnapshotAlreadyExistsException - You already have a snapshot with the given name.

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidSnapshotStateException - The current state of the snapshot does not allow the requested action to occur.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a CreateCacheCluster action.

Returns:

Result of the CreateCacheCluster operation returned by the service.

Throws:

ReplicationGroupNotFoundException - The specified replication group does not exist.

InvalidReplicationGroupStateException - The requested replication group is not in the available state.

CacheClusterAlreadyExistsException - You already have a cache cluster with the given identifier.

InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.

ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a CreateCacheParameterGroup action.

Returns:

Result of the CreateCacheParameterGroup operation returned by the service.

Throws:

CacheParameterGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum number of cache security groups.

CacheParameterGroupAlreadyExistsException - A cache parameter group with the requested name already exists.

InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested action to occur.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a CreateCacheSecurityGroup action.

Returns:

Result of the CreateCacheSecurityGroup operation returned by the service.

Throws:

CacheSecurityGroupAlreadyExistsException - A cache security group with the specified name already exists.

CacheSecurityGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache security groups.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a CreateCacheSubnetGroup action.

Returns:

Result of the CreateCacheSubnetGroup operation returned by the service.

Throws:

CacheSubnetGroupAlreadyExistsException - The requested cache subnet group name is already in use by an existing cache subnet group.

CacheSubnetGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache subnet groups.

CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

InvalidSubnetException - An invalid subnet identifier was specified.

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 - Represents the input of a CreateReplicationGroup action.

Returns:

Result of the CreateReplicationGroup operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

ReplicationGroupAlreadyExistsException - The specified replication group already exists.

InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.

ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a CreateSnapshot action.

Returns:

Result of the CreateSnapshot operation returned by the service.

Throws:

SnapshotAlreadyExistsException - You already have a snapshot with the given name.

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.

SnapshotFeatureNotSupportedException - You attempted one of the following actions:

• Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

• Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

InvalidParameterValueException - The value for a parameter is invalid.

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 - Represents the input of a DeleteCacheCluster action.

Returns:

Result of the DeleteCacheCluster operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

SnapshotAlreadyExistsException - You already have a snapshot with the given name.

SnapshotFeatureNotSupportedException - You attempted one of the following actions:

• Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

• Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

deleteCacheParameterGroup

public DeleteCacheParameterGroupResult 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 - Represents the input of a DeleteCacheParameterGroup action.

Returns:

Result of the DeleteCacheParameterGroup operation returned by the service.

Throws:

InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested action to occur.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

deleteCacheSecurityGroup

public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)

The DeleteCacheSecurityGroup action deletes a cache security group.

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

Specified by:

deleteCacheSecurityGroup in interface AmazonElastiCache

Parameters:

deleteCacheSecurityGroupRequest - Represents the input of a DeleteCacheSecurityGroup action.

Returns:

Result of the DeleteCacheSecurityGroup operation returned by the service.

Throws:

InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

deleteCacheSubnetGroup

public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)

The DeleteCacheSubnetGroup action deletes a cache subnet group.

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

Specified by:

deleteCacheSubnetGroup in interface AmazonElastiCache

Parameters:

deleteCacheSubnetGroupRequest - Represents the input of a DeleteCacheSubnetGroup action.

Returns:

Result of the DeleteCacheSubnetGroup operation returned by the service.

Throws:

CacheSubnetGroupInUseException - The requested cache subnet group is currently in use.

CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.

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 - Represents the input of a DeleteReplicationGroup action.

Returns:

Result of the DeleteReplicationGroup operation returned by the service.

Throws:

ReplicationGroupNotFoundException - The specified replication group does not exist.

InvalidReplicationGroupStateException - The requested replication group is not in the available state.

SnapshotAlreadyExistsException - You already have a snapshot with the given name.

SnapshotFeatureNotSupportedException - You attempted one of the following actions:

• Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

• Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a DeleteSnapshot action.

Returns:

Result of the DeleteSnapshot operation returned by the service.

Throws:

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

InvalidSnapshotStateException - The current state of the snapshot does not allow the requested action to occur.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a DescribeCacheClusters action.

Returns:

Result of the DescribeCacheClusters operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeCacheClusters

public DescribeCacheClustersResult describeCacheClusters()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeCacheClusters operation.

Specified by:

describeCacheClusters in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)

describeCacheEngineVersions

public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)

The DescribeCacheEngineVersions action returns a list of the available cache engines and their versions.

Specified by:

describeCacheEngineVersions in interface AmazonElastiCache

Parameters:

describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions action.

Returns:

Result of the DescribeCacheEngineVersions operation returned by the service.

describeCacheEngineVersions

public DescribeCacheEngineVersionsResult describeCacheEngineVersions()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeCacheEngineVersions operation.

Specified by:

describeCacheEngineVersions in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)

describeCacheParameterGroups

public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest 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 - Represents the input of a DescribeCacheParameterGroups action.

Returns:

Result of the DescribeCacheParameterGroups operation returned by the service.

Throws:

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeCacheParameterGroups

public DescribeCacheParameterGroupsResult describeCacheParameterGroups()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeCacheParameterGroups operation.

Specified by:

describeCacheParameterGroups in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)

describeCacheParameters

public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)

The DescribeCacheParameters action returns the detailed parameter list for a particular cache parameter group.

Specified by:

describeCacheParameters in interface AmazonElastiCache

Parameters:

describeCacheParametersRequest - Represents the input of a DescribeCacheParameters action.

Returns:

Result of the DescribeCacheParameters operation returned by the service.

Throws:

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a DescribeCacheSecurityGroups action.

Returns:

Result of the DescribeCacheSecurityGroups operation returned by the service.

Throws:

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeCacheSecurityGroups

public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeCacheSecurityGroups operation.

Specified by:

describeCacheSecurityGroups in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)

describeCacheSubnetGroups

public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest 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 - Represents the input of a DescribeCacheSubnetGroups action.

Returns:

Result of the DescribeCacheSubnetGroups operation returned by the service.

Throws:

CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.

describeCacheSubnetGroups

public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeCacheSubnetGroups operation.

Specified by:

describeCacheSubnetGroups in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)

describeEngineDefaultParameters

public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest 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 - Represents the input of a DescribeEngineDefaultParameters action.

Returns:

Result of the DescribeEngineDefaultParameters operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a DescribeEvents action.

Returns:

Result of the DescribeEvents operation returned by the service.

Throws:

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeEvents

public DescribeEventsResult describeEvents()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeEvents operation.

Specified by:

describeEvents in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeEvents(DescribeEventsRequest)

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 - Represents the input of a DescribeReplicationGroups action.

Returns:

Result of the DescribeReplicationGroups operation returned by the service.

Throws:

ReplicationGroupNotFoundException - The specified replication group does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeReplicationGroups

public DescribeReplicationGroupsResult describeReplicationGroups()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeReplicationGroups operation.

Specified by:

describeReplicationGroups in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)

describeReservedCacheNodes

public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest 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 - Represents the input of a DescribeReservedCacheNodes action.

Returns:

Result of the DescribeReservedCacheNodes operation returned by the service.

Throws:

ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeReservedCacheNodes

public DescribeReservedCacheNodesResult describeReservedCacheNodes()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeReservedCacheNodes operation.

Specified by:

describeReservedCacheNodes in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)

describeReservedCacheNodesOfferings

public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)

The DescribeReservedCacheNodesOfferings action lists available reserved cache node offerings.

Specified by:

describeReservedCacheNodesOfferings in interface AmazonElastiCache

Parameters:

describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings action.

Returns:

Result of the DescribeReservedCacheNodesOfferings operation returned by the service.

Throws:

ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeReservedCacheNodesOfferings

public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.

Specified by:

describeReservedCacheNodesOfferings in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)

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 - Represents the input of a DescribeSnapshotsMessage action.

Returns:

Result of the DescribeSnapshots operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

describeSnapshots

public DescribeSnapshotsResult describeSnapshots()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the DescribeSnapshots operation.

Specified by:

describeSnapshots in interface AmazonElastiCache

See Also:

AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)

listAllowedNodeTypeModifications

public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)

The ListAllowedNodeTypeModifications action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

When you use the ModifyCacheCluster or ModifyReplicationGroup APIs to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this action.

Specified by:

listAllowedNodeTypeModifications in interface AmazonElastiCache

Parameters:

listAllowedNodeTypeModificationsRequest - The input parameters for the ListAllowedNodeTypeModifications action.

Returns:

Result of the ListAllowedNodeTypeModifications operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

ReplicationGroupNotFoundException - The specified replication group does not exist.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

InvalidParameterValueException - The value for a parameter is invalid.

listAllowedNodeTypeModifications

public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()

Description copied from interface: AmazonElastiCache

Simplified method form for invoking the ListAllowedNodeTypeModifications operation.

Specified by:

listAllowedNodeTypeModifications in interface AmazonElastiCache

See Also:

AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest 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 - The input parameters for the ListTagsForResource action.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

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 - Represents the input of a ModifyCacheCluster action.

Returns:

Result of the ModifyCacheCluster operation returned by the service.

Throws:

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.

InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a ModifyCacheParameterGroup action.

Returns:

Result of the ModifyCacheParameterGroup operation returned by the service.

Throws:

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested action to occur.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

modifyCacheSubnetGroup

public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)

The ModifyCacheSubnetGroup action modifies an existing cache subnet group.

Specified by:

modifyCacheSubnetGroup in interface AmazonElastiCache

Parameters:

modifyCacheSubnetGroupRequest - Represents the input of a ModifyCacheSubnetGroup action.

Returns:

Result of the ModifyCacheSubnetGroup operation returned by the service.

Throws:

CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.

CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

SubnetInUseException - The requested subnet is being used by another cache subnet group.

InvalidSubnetException - An invalid subnet identifier was specified.

modifyReplicationGroup

public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)

The ModifyReplicationGroup action modifies the settings for a replication group.

Specified by:

modifyReplicationGroup in interface AmazonElastiCache

Parameters:

modifyReplicationGroupRequest - Represents the input of a ModifyReplicationGroups action.

Returns:

Result of the ModifyReplicationGroup operation returned by the service.

Throws:

ReplicationGroupNotFoundException - The specified replication group does not exist.

InvalidReplicationGroupStateException - The requested replication group is not in the available state.

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.

InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone.

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidVPCNetworkStateException - The VPC network is in an invalid state.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a PurchaseReservedCacheNodesOffering action.

Returns:

Result of the PurchaseReservedCacheNodesOffering operation returned by the service.

Throws:

ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.

ReservedCacheNodeAlreadyExistsException - You already have a reservation with the given identifier.

ReservedCacheNodeQuotaExceededException - The request cannot be processed because it would exceed the user's cache node quota.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a RebootCacheCluster action.

Returns:

Result of the RebootCacheCluster operation returned by the service.

Throws:

InvalidCacheClusterStateException - The requested cache cluster is not in the available state.

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

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 - Represents the input of a RemoveTagsFromResource action.

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

CacheClusterNotFoundException - The requested cache cluster ID does not refer to an existing cache cluster.

SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.

InvalidARNException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.

TagNotFoundException - The requested tag was not found on this resource.

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 - Represents the input of a ResetCacheParameterGroup action.

Returns:

Result of the ResetCacheParameterGroup operation returned by the service.

Throws:

InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested action to occur.

CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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 - Represents the input of a RevokeCacheSecurityGroupIngress action.

Returns:

Result of the RevokeCacheSecurityGroupIngress operation returned by the service.

Throws:

CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.

AuthorizationNotFoundException - The specified Amazon EC2 security group is not authorized for the specified cache security group.

InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.

InvalidParameterValueException - The value for a parameter is invalid.

InvalidParameterCombinationException - Two or more incompatible parameters were specified.

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.