@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonElastiCache extends Object implements AmazonElastiCache
AmazonElastiCache
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds up to 50 cost allocation tags to the named resource.
|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
Allows network ingress to a cache security group.
|
Snapshot |
copySnapshot(CopySnapshotRequest request)
Makes a copy of an existing snapshot.
|
CacheCluster |
createCacheCluster(CreateCacheClusterRequest request)
Creates a cluster.
|
CacheParameterGroup |
createCacheParameterGroup(CreateCacheParameterGroupRequest request)
Creates a new Amazon ElastiCache cache parameter group.
|
CacheSecurityGroup |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
Creates a new cache security group.
|
CacheSubnetGroup |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
Creates a new cache subnet group.
|
ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest request)
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
|
Snapshot |
createSnapshot(CreateSnapshotRequest request)
Creates a copy of an entire cluster or replication group at a specific moment in time.
|
CacheCluster |
deleteCacheCluster(DeleteCacheClusterRequest request)
Deletes a previously provisioned cluster.
|
DeleteCacheParameterGroupResult |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
Deletes the specified cache parameter group.
|
DeleteCacheSecurityGroupResult |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
Deletes a cache security group.
|
DeleteCacheSubnetGroupResult |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
Deletes a cache subnet group.
|
ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest request)
Deletes an existing replication group.
|
Snapshot |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes an existing snapshot.
|
DescribeCacheClustersResult |
describeCacheClusters()
Simplified method form for invoking the DescribeCacheClusters operation.
|
DescribeCacheClustersResult |
describeCacheClusters(DescribeCacheClustersRequest request)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions()
Simplified method form for invoking the DescribeCacheEngineVersions operation.
|
DescribeCacheEngineVersionsResult |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
Returns a list of the available cache engines and their versions.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups()
Simplified method form for invoking the DescribeCacheParameterGroups operation.
|
DescribeCacheParameterGroupsResult |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
Returns a list of cache parameter group descriptions.
|
DescribeCacheParametersResult |
describeCacheParameters(DescribeCacheParametersRequest request)
Returns the detailed parameter list for a particular cache parameter group.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups()
Simplified method form for invoking the DescribeCacheSecurityGroups operation.
|
DescribeCacheSecurityGroupsResult |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
Returns a list of cache security group descriptions.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups()
Simplified method form for invoking the DescribeCacheSubnetGroups operation.
|
DescribeCacheSubnetGroupsResult |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
Returns a list of cache subnet group descriptions.
|
EngineDefaults |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
Returns the default engine and system parameter information for the specified cache engine.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest request)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
DescribeReplicationGroupsResult |
describeReplicationGroups()
Simplified method form for invoking the DescribeReplicationGroups operation.
|
DescribeReplicationGroupsResult |
describeReplicationGroups(DescribeReplicationGroupsRequest request)
Returns information about a particular replication group.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes()
Simplified method form for invoking the DescribeReservedCacheNodes operation.
|
DescribeReservedCacheNodesResult |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings()
Simplified method form for invoking the DescribeReservedCacheNodesOfferings operation.
|
DescribeReservedCacheNodesOfferingsResult |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
Lists available reserved cache node offerings.
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest request)
Returns information about cluster or replication group snapshots.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications()
Simplified method form for invoking the ListAllowedNodeTypeModifications operation.
|
ListAllowedNodeTypeModificationsResult |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
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 request)
Lists all cost allocation tags currently on the named resource.
|
CacheCluster |
modifyCacheCluster(ModifyCacheClusterRequest request)
Modifies the settings for a cluster.
|
ModifyCacheParameterGroupResult |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
Modifies the parameters of a cache parameter group.
|
CacheSubnetGroup |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
Modifies an existing cache subnet group.
|
ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest request)
Modifies the settings for a replication group.
|
ReplicationGroup |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime.
|
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
Allows you to purchase a reserved cache node offering.
|
CacheCluster |
rebootCacheCluster(RebootCacheClusterRequest request)
Reboots some, or all, of the cache nodes within a provisioned cluster.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes the tags identified by the
TagKeys list from the named resource. |
ResetCacheParameterGroupResult |
resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
Modifies the parameters of a cache parameter group to the engine or system default value.
|
CacheSecurityGroup |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
Revokes ingress from a cache security group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("elasticache.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonElastiCache.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
ReplicationGroup |
testFailover(TestFailoverRequest request)
Represents the input of a
TestFailover operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
AmazonElastiCacheWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonElastiCache
Callers can pass in just the endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "elasticache.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonElastiCache
endpoint
- The endpoint (ex: "elasticache.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"elasticache.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonElastiCache
AmazonElastiCache.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonElastiCache
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AmazonElastiCache
Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
addTagsToResource
in interface AmazonElastiCache
request
- Represents the input of an AddTagsToResource operation.public CacheSecurityGroup authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
AmazonElastiCache
Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
authorizeCacheSecurityGroupIngress
in interface AmazonElastiCache
request
- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.public Snapshot copySnapshot(CopySnapshotRequest request)
AmazonElastiCache
Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the CopySnapshot
operation can create their own Amazon
S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has
the ability to use the CopySnapshot
operation. For more information about using IAM to control the
use of ElastiCache operations, see Exporting
Snapshots and Authentication
& Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName
a new and unique value. If exporting a snapshot, you
could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName
.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
copySnapshot
in interface AmazonElastiCache
request
- Represents the input of a CopySnapshotMessage
operation.public CacheCluster createCacheCluster(CreateCacheClusterRequest request)
AmazonElastiCache
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
createCacheCluster
in interface AmazonElastiCache
request
- Represents the input of a CreateCacheCluster operation.public CacheParameterGroup createCacheParameterGroup(CreateCacheParameterGroupRequest request)
AmazonElastiCache
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.
createCacheParameterGroup
in interface AmazonElastiCache
request
- Represents the input of a CreateCacheParameterGroup
operation.public CacheSecurityGroup createCacheSecurityGroup(CreateCacheSecurityGroupRequest request)
AmazonElastiCache
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
createCacheSecurityGroup
in interface AmazonElastiCache
request
- Represents the input of a CreateCacheSecurityGroup
operation.public CacheSubnetGroup createCacheSubnetGroup(CreateCacheSubnetGroupRequest request)
AmazonElastiCache
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroup
in interface AmazonElastiCache
request
- Represents the input of a CreateCacheSubnetGroup
operation.public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest request)
AmazonElastiCache
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.
This operation is valid for Redis only.
createReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a CreateReplicationGroup
operation.public Snapshot createSnapshot(CreateSnapshotRequest request)
AmazonElastiCache
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
createSnapshot
in interface AmazonElastiCache
request
- Represents the input of a CreateSnapshot
operation.public CacheCluster deleteCacheCluster(DeleteCacheClusterRequest request)
AmazonElastiCache
Deletes a previously provisioned cluster. DeleteCacheCluster
deletes all associated cache nodes,
node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon
ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
deleteCacheCluster
in interface AmazonElastiCache
request
- Represents the input of a DeleteCacheCluster
operation.public DeleteCacheParameterGroupResult deleteCacheParameterGroup(DeleteCacheParameterGroupRequest request)
AmazonElastiCache
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
deleteCacheParameterGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteCacheParameterGroup
operation.public DeleteCacheSecurityGroupResult deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request)
AmazonElastiCache
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
deleteCacheSecurityGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteCacheSecurityGroup
operation.public DeleteCacheSubnetGroupResult deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request)
AmazonElastiCache
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any clusters.
deleteCacheSubnetGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteCacheSubnetGroup
operation.public ReplicationGroup deleteReplicationGroup(DeleteReplicationGroupRequest request)
AmazonElastiCache
Deletes an existing replication group. By default, this operation deletes the entire replication group, including
the primary/primaries and all of the read replicas. If the replication group has only one primary, you can
optionally delete only the read replicas, while retaining the primary by setting
RetainPrimaryCluster=true
.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This operation is valid for Redis only.
deleteReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteReplicationGroup
operation.public Snapshot deleteSnapshot(DeleteSnapshotRequest request)
AmazonElastiCache
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Redis only.
deleteSnapshot
in interface AmazonElastiCache
request
- Represents the input of a DeleteSnapshot
operation.public DescribeCacheClustersResult describeCacheClusters(DescribeCacheClustersRequest request)
AmazonElastiCache
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
describeCacheClusters
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheClusters
operation.public DescribeCacheClustersResult describeCacheClusters()
AmazonElastiCache
describeCacheClusters
in interface AmazonElastiCache
AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest)
public DescribeCacheEngineVersionsResult describeCacheEngineVersions(DescribeCacheEngineVersionsRequest request)
AmazonElastiCache
Returns a list of the available cache engines and their versions.
describeCacheEngineVersions
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheEngineVersions
operation.public DescribeCacheEngineVersionsResult describeCacheEngineVersions()
AmazonElastiCache
describeCacheEngineVersions
in interface AmazonElastiCache
AmazonElastiCache.describeCacheEngineVersions(DescribeCacheEngineVersionsRequest)
public DescribeCacheParameterGroupsResult describeCacheParameterGroups(DescribeCacheParameterGroupsRequest request)
AmazonElastiCache
Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
describeCacheParameterGroups
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheParameterGroups
operation.public DescribeCacheParameterGroupsResult describeCacheParameterGroups()
AmazonElastiCache
describeCacheParameterGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest)
public DescribeCacheParametersResult describeCacheParameters(DescribeCacheParametersRequest request)
AmazonElastiCache
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParameters
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheParameters
operation.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest request)
AmazonElastiCache
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.
describeCacheSecurityGroups
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheSecurityGroups
operation.public DescribeCacheSecurityGroupsResult describeCacheSecurityGroups()
AmazonElastiCache
describeCacheSecurityGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest)
public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest request)
AmazonElastiCache
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
describeCacheSubnetGroups
in interface AmazonElastiCache
request
- Represents the input of a DescribeCacheSubnetGroups
operation.public DescribeCacheSubnetGroupsResult describeCacheSubnetGroups()
AmazonElastiCache
describeCacheSubnetGroups
in interface AmazonElastiCache
AmazonElastiCache.describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest)
public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request)
AmazonElastiCache
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParameters
in interface AmazonElastiCache
request
- Represents the input of a DescribeEngineDefaultParameters
operation.public DescribeEventsResult describeEvents(DescribeEventsRequest request)
AmazonElastiCache
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
describeEvents
in interface AmazonElastiCache
request
- Represents the input of a DescribeEvents
operation.public DescribeEventsResult describeEvents()
AmazonElastiCache
describeEvents
in interface AmazonElastiCache
AmazonElastiCache.describeEvents(DescribeEventsRequest)
public DescribeReplicationGroupsResult describeReplicationGroups(DescribeReplicationGroupsRequest request)
AmazonElastiCache
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroups
returns information about all replication groups.
This operation is valid for Redis only.
describeReplicationGroups
in interface AmazonElastiCache
request
- Represents the input of a DescribeReplicationGroups
operation.public DescribeReplicationGroupsResult describeReplicationGroups()
AmazonElastiCache
describeReplicationGroups
in interface AmazonElastiCache
AmazonElastiCache.describeReplicationGroups(DescribeReplicationGroupsRequest)
public DescribeReservedCacheNodesResult describeReservedCacheNodes(DescribeReservedCacheNodesRequest request)
AmazonElastiCache
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodes
in interface AmazonElastiCache
request
- Represents the input of a DescribeReservedCacheNodes
operation.public DescribeReservedCacheNodesResult describeReservedCacheNodes()
AmazonElastiCache
describeReservedCacheNodes
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodes(DescribeReservedCacheNodesRequest)
public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request)
AmazonElastiCache
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
request
- Represents the input of a DescribeReservedCacheNodesOfferings
operation.public DescribeReservedCacheNodesOfferingsResult describeReservedCacheNodesOfferings()
AmazonElastiCache
describeReservedCacheNodesOfferings
in interface AmazonElastiCache
AmazonElastiCache.describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest)
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
AmazonElastiCache
Returns information about cluster or replication group snapshots. By default, DescribeSnapshots
lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with
a particular cache cluster.
This operation is valid for Redis only.
describeSnapshots
in interface AmazonElastiCache
request
- Represents the input of a DescribeSnapshotsMessage
operation.public DescribeSnapshotsResult describeSnapshots()
AmazonElastiCache
describeSnapshots
in interface AmazonElastiCache
AmazonElastiCache.describeSnapshots(DescribeSnapshotsRequest)
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
AmazonElastiCache
Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
When you use the ModifyCacheCluster
or ModifyReplicationGroup
operations to scale up
your cluster or replication group, the value of the CacheNodeType
parameter must be one of the node
types returned by this operation.
listAllowedNodeTypeModifications
in interface AmazonElastiCache
request
- The input parameters for the ListAllowedNodeTypeModifications
operation.public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications()
AmazonElastiCache
listAllowedNodeTypeModifications
in interface AmazonElastiCache
AmazonElastiCache.listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest)
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonElastiCache
Lists all cost allocation tags currently on the named resource. A cost allocation tag
is a key-value
pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize
and track your AWS costs.
You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.
listTagsForResource
in interface AmazonElastiCache
request
- The input parameters for the ListTagsForResource
operation.public CacheCluster modifyCacheCluster(ModifyCacheClusterRequest request)
AmazonElastiCache
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
modifyCacheCluster
in interface AmazonElastiCache
request
- Represents the input of a ModifyCacheCluster
operation.public ModifyCacheParameterGroupResult modifyCacheParameterGroup(ModifyCacheParameterGroupRequest request)
AmazonElastiCache
Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
modifyCacheParameterGroup
in interface AmazonElastiCache
request
- Represents the input of a ModifyCacheParameterGroup
operation.public CacheSubnetGroup modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request)
AmazonElastiCache
Modifies an existing cache subnet group.
modifyCacheSubnetGroup
in interface AmazonElastiCache
request
- Represents the input of a ModifyCacheSubnetGroup
operation.public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest request)
AmazonElastiCache
Modifies the settings for a replication group.
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
This operation is valid for Redis only.
modifyReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a ModifyReplicationGroups
operation.public ReplicationGroup modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
AmazonElastiCache
Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime. Requires Redis engine version 3.2.10 or newer. For information on upgrading your engine to a newer version, see Upgrading Engine Versions in the Amazon ElastiCache User Guide.
For more information on ElastiCache for Redis online horizontal scaling, see ElastiCache for Redis Horizontal Scaling
modifyReplicationGroupShardConfiguration
in interface AmazonElastiCache
request
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
AmazonElastiCache
Allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOffering
in interface AmazonElastiCache
request
- Represents the input of a PurchaseReservedCacheNodesOffering
operation.public CacheCluster rebootCacheCluster(RebootCacheClusterRequest request)
AmazonElastiCache
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
rebootCacheCluster
in interface AmazonElastiCache
request
- Represents the input of a RebootCacheCluster
operation.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AmazonElastiCache
Removes the tags identified by the TagKeys
list from the named resource.
removeTagsFromResource
in interface AmazonElastiCache
request
- Represents the input of a RemoveTagsFromResource
operation.public ResetCacheParameterGroupResult resetCacheParameterGroup(ResetCacheParameterGroupRequest request)
AmazonElastiCache
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific
parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the
ResetAllParameters
and CacheParameterGroupName
parameters.
resetCacheParameterGroup
in interface AmazonElastiCache
request
- Represents the input of a ResetCacheParameterGroup
operation.public CacheSecurityGroup revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest request)
AmazonElastiCache
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngress
in interface AmazonElastiCache
request
- Represents the input of a RevokeCacheSecurityGroupIngress
operation.public ReplicationGroup testFailover(TestFailoverRequest request)
AmazonElastiCache
Represents the input of a TestFailover
operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console).
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
testFailover
in interface AmazonElastiCache
public void shutdown()
AmazonElastiCache
shutdown
in interface AmazonElastiCache
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonElastiCache
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.
getCachedResponseMetadata
in interface AmazonElastiCache
request
- The originally executed request.public AmazonElastiCacheWaiters waiters()
waiters
in interface AmazonElastiCache
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.