@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)
A tag is a key-value pair where the key and value are case-sensitive.
|
CacheSecurityGroup |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest request)
Allows network ingress to a cache security group.
|
BatchApplyUpdateActionResult |
batchApplyUpdateAction(BatchApplyUpdateActionRequest request)
Apply the service update.
|
BatchStopUpdateActionResult |
batchStopUpdateAction(BatchStopUpdateActionRequest request)
Stop the service update.
|
ReplicationGroup |
completeMigration(CompleteMigrationRequest request)
Complete the migration of data.
|
CopyServerlessCacheSnapshotResult |
copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest request)
Creates a copy of an existing serverless cache’s snapshot.
|
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.
|
GlobalReplicationGroup |
createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)
Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication.
|
ReplicationGroup |
createReplicationGroup(CreateReplicationGroupRequest request)
Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.
|
CreateServerlessCacheResult |
createServerlessCache(CreateServerlessCacheRequest request)
Creates a serverless cache.
|
CreateServerlessCacheSnapshotResult |
createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest request)
This API creates a copy of an entire ServerlessCache at a specific moment in time.
|
Snapshot |
createSnapshot(CreateSnapshotRequest request)
Creates a copy of an entire cluster or replication group at a specific moment in time.
|
CreateUserResult |
createUser(CreateUserRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user.
|
CreateUserGroupResult |
createUserGroup(CreateUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group.
|
GlobalReplicationGroup |
decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
Decreases the number of node groups in a Global datastore
|
ReplicationGroup |
decreaseReplicaCount(DecreaseReplicaCountRequest request)
Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the
number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication
group.
|
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.
|
GlobalReplicationGroup |
deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)
Deleting a Global datastore is a two-step process:
|
ReplicationGroup |
deleteReplicationGroup(DeleteReplicationGroupRequest request)
Deletes an existing replication group.
|
DeleteServerlessCacheResult |
deleteServerlessCache(DeleteServerlessCacheRequest request)
Deletes a specified existing serverless cache.
|
DeleteServerlessCacheSnapshotResult |
deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest request)
Deletes an existing serverless cache snapshot.
|
Snapshot |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes an existing snapshot.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user.
|
DeleteUserGroupResult |
deleteUserGroup(DeleteUserGroupRequest request)
For Redis OSS engine version 6.0 onwards: Deletes a user group.
|
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.
|
DescribeGlobalReplicationGroupsResult |
describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)
Returns information about a particular global replication group.
|
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.
|
DescribeServerlessCachesResult |
describeServerlessCaches(DescribeServerlessCachesRequest request)
Returns information about a specific serverless cache.
|
DescribeServerlessCacheSnapshotsResult |
describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest request)
Returns information about serverless cache snapshots.
|
DescribeServiceUpdatesResult |
describeServiceUpdates(DescribeServiceUpdatesRequest request)
Returns details of the service updates
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest request)
Returns information about cluster or replication group snapshots.
|
DescribeUpdateActionsResult |
describeUpdateActions(DescribeUpdateActionsRequest request)
Returns details of the update actions
|
DescribeUserGroupsResult |
describeUserGroups(DescribeUserGroupsRequest request)
Returns a list of user groups.
|
DescribeUsersResult |
describeUsers(DescribeUsersRequest request)
Returns a list of users.
|
GlobalReplicationGroup |
disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)
Remove a secondary cluster from the Global datastore using the Global datastore name.
|
ExportServerlessCacheSnapshotResult |
exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest request)
Provides the functionality to export the serverless cache snapshot data to Amazon S3.
|
GlobalReplicationGroup |
failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)
Used to failover the primary region to a secondary region.
|
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.
|
GlobalReplicationGroup |
increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
Increase the number of node groups in the Global datastore
|
ReplicationGroup |
increaseReplicaCount(IncreaseReplicaCountRequest request)
Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the
number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication
group.
|
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 OSS cluster's or replication group's current node
type.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags currently on a 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.
|
GlobalReplicationGroup |
modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)
Modifies the settings for a Global datastore.
|
ReplicationGroup |
modifyReplicationGroup(ModifyReplicationGroupRequest request)
Modifies the settings for a replication group.
|
ReplicationGroup |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among existing shards.
|
ModifyServerlessCacheResult |
modifyServerlessCache(ModifyServerlessCacheRequest request)
This API modifies the attributes of a serverless cache.
|
ModifyUserResult |
modifyUser(ModifyUserRequest request)
Changes user password(s) and/or access string.
|
ModifyUserGroupResult |
modifyUserGroup(ModifyUserGroupRequest request)
Changes the list of users that belong to the user group.
|
ReservedCacheNode |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
Allows you to purchase a reserved cache node offering.
|
GlobalReplicationGroup |
rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
|
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 |
startMigration(StartMigrationRequest request)
Start the migration of data.
|
ReplicationGroup |
testFailover(TestFailoverRequest request)
Represents the input of a
TestFailover operation which tests automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
ReplicationGroup |
testMigration(TestMigrationRequest request)
Async API to test connection between source and target replication group.
|
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon 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 BatchApplyUpdateActionResult batchApplyUpdateAction(BatchApplyUpdateActionRequest request)
AmazonElastiCache
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batchApplyUpdateAction
in interface AmazonElastiCache
public BatchStopUpdateActionResult batchStopUpdateAction(BatchStopUpdateActionRequest request)
AmazonElastiCache
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
batchStopUpdateAction
in interface AmazonElastiCache
public ReplicationGroup completeMigration(CompleteMigrationRequest request)
AmazonElastiCache
Complete the migration of data.
completeMigration
in interface AmazonElastiCache
public CopyServerlessCacheSnapshotResult copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest request)
AmazonElastiCache
Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.
copyServerlessCacheSnapshot
in interface AmazonElastiCache
public Snapshot copySnapshot(CopySnapshotRequest request)
AmazonElastiCache
Makes a copy of an existing snapshot.
This operation is valid for Redis OSS 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 OSS.
This operation is not supported for Redis OSS (cluster mode enabled) clusters.
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 GlobalReplicationGroup createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest request)
AmazonElastiCache
Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
createGlobalReplicationGroup
in interface AmazonElastiCache
public ReplicationGroup createReplicationGroup(CreateReplicationGroupRequest request)
AmazonElastiCache
Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis OSS (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. If you need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling. For more information, see Scaling ElastiCache (Redis OSS) Clusters in the ElastiCache User Guide.
This operation is valid for Redis OSS only.
createReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a CreateReplicationGroup
operation.public CreateServerlessCacheResult createServerlessCache(CreateServerlessCacheRequest request)
AmazonElastiCache
Creates a serverless cache.
createServerlessCache
in interface AmazonElastiCache
public CreateServerlessCacheSnapshotResult createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest request)
AmazonElastiCache
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.
createServerlessCacheSnapshot
in interface AmazonElastiCache
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 OSS only.
createSnapshot
in interface AmazonElastiCache
request
- Represents the input of a CreateSnapshot
operation.public CreateUserResult createUser(CreateUserRequest request)
AmazonElastiCache
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access Control (RBAC).
createUser
in interface AmazonElastiCache
public CreateUserGroupResult createUserGroup(CreateUserGroupRequest request)
AmazonElastiCache
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access Control (RBAC)
createUserGroup
in interface AmazonElastiCache
public GlobalReplicationGroup decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request)
AmazonElastiCache
Decreases the number of node groups in a Global datastore
decreaseNodeGroupsInGlobalReplicationGroup
in interface AmazonElastiCache
public ReplicationGroup decreaseReplicaCount(DecreaseReplicaCountRequest request)
AmazonElastiCache
Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
decreaseReplicaCount
in interface AmazonElastiCache
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 is not valid for:
Redis OSS (cluster mode enabled) clusters
Redis OSS (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis OSS (cluster mode enabled) replication group
A cluster that is not in the available
state
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. You cannot delete the default cache parameter groups in your account.
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 default cache subnet group or one that is associated with any clusters.
deleteCacheSubnetGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteCacheSubnetGroup
operation.public GlobalReplicationGroup deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest request)
AmazonElastiCache
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroup
API to delete the Global datastore while retainining the primary
cluster using RetainPrimaryReplicationGroup=true
.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
primary by setting RetainPrimaryReplicationGroup=true
. The primary cluster is never deleted when
deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
deleteGlobalReplicationGroup
in interface AmazonElastiCache
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.
CreateSnapshot
permission is required to create a final snapshot. Without this permission, the API
call will fail with an Access Denied
exception.
This operation is valid for Redis OSS only.
deleteReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a DeleteReplicationGroup
operation.public DeleteServerlessCacheResult deleteServerlessCache(DeleteServerlessCacheRequest request)
AmazonElastiCache
Deletes a specified existing serverless cache.
CreateServerlessCacheSnapshot
permission is required to create a final snapshot. Without this
permission, the API call will fail with an Access Denied
exception.
deleteServerlessCache
in interface AmazonElastiCache
public DeleteServerlessCacheSnapshotResult deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest request)
AmazonElastiCache
Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
deleteServerlessCacheSnapshot
in interface AmazonElastiCache
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 OSS only.
deleteSnapshot
in interface AmazonElastiCache
request
- Represents the input of a DeleteSnapshot
operation.public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonElastiCache
For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
deleteUser
in interface AmazonElastiCache
public DeleteUserGroupResult deleteUserGroup(DeleteUserGroupRequest request)
AmazonElastiCache
For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
deleteUserGroup
in interface AmazonElastiCache
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. This applicable only when you have ElastiCache in Classic setup
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. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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 DescribeGlobalReplicationGroupsResult describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request)
AmazonElastiCache
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
describeGlobalReplicationGroups
in interface AmazonElastiCache
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 OSS 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 DescribeServerlessCacheSnapshotsResult describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest request)
AmazonElastiCache
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis OSS and Serverless Memcached only.
describeServerlessCacheSnapshots
in interface AmazonElastiCache
public DescribeServerlessCachesResult describeServerlessCaches(DescribeServerlessCachesRequest request)
AmazonElastiCache
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
describeServerlessCaches
in interface AmazonElastiCache
public DescribeServiceUpdatesResult describeServiceUpdates(DescribeServiceUpdatesRequest request)
AmazonElastiCache
Returns details of the service updates
describeServiceUpdates
in interface AmazonElastiCache
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 OSS 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 DescribeUpdateActionsResult describeUpdateActions(DescribeUpdateActionsRequest request)
AmazonElastiCache
Returns details of the update actions
describeUpdateActions
in interface AmazonElastiCache
public DescribeUserGroupsResult describeUserGroups(DescribeUserGroupsRequest request)
AmazonElastiCache
Returns a list of user groups.
describeUserGroups
in interface AmazonElastiCache
public DescribeUsersResult describeUsers(DescribeUsersRequest request)
AmazonElastiCache
Returns a list of users.
describeUsers
in interface AmazonElastiCache
public GlobalReplicationGroup disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest request)
AmazonElastiCache
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
disassociateGlobalReplicationGroup
in interface AmazonElastiCache
public ExportServerlessCacheSnapshotResult exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest request)
AmazonElastiCache
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.
exportServerlessCacheSnapshot
in interface AmazonElastiCache
public GlobalReplicationGroup failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request)
AmazonElastiCache
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
failoverGlobalReplicationGroup
in interface AmazonElastiCache
public GlobalReplicationGroup increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request)
AmazonElastiCache
Increase the number of node groups in the Global datastore
increaseNodeGroupsInGlobalReplicationGroup
in interface AmazonElastiCache
public ReplicationGroup increaseReplicaCount(IncreaseReplicaCountRequest request)
AmazonElastiCache
Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
increaseReplicaCount
in interface AmazonElastiCache
public ListAllowedNodeTypeModificationsResult listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest request)
AmazonElastiCache
Lists all available node types that you can scale your Redis OSS cluster's or replication group's current node type.
When you use the ModifyCacheCluster
or ModifyReplicationGroup
operations to scale 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 tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
If the cluster is not in the available state, ListTagsForResource
returns an error.
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 GlobalReplicationGroup modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request)
AmazonElastiCache
Modifies the settings for a Global datastore.
modifyGlobalReplicationGroup
in interface AmazonElastiCache
public ReplicationGroup modifyReplicationGroup(ModifyReplicationGroupRequest request)
AmazonElastiCache
Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer.
Scaling for Amazon ElastiCache (Redis OSS) (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis OSS only.
modifyReplicationGroup
in interface AmazonElastiCache
request
- Represents the input of a ModifyReplicationGroups
operation.public ReplicationGroup modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request)
AmazonElastiCache
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
modifyReplicationGroupShardConfiguration
in interface AmazonElastiCache
request
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.public ModifyServerlessCacheResult modifyServerlessCache(ModifyServerlessCacheRequest request)
AmazonElastiCache
This API modifies the attributes of a serverless cache.
modifyServerlessCache
in interface AmazonElastiCache
public ModifyUserResult modifyUser(ModifyUserRequest request)
AmazonElastiCache
Changes user password(s) and/or access string.
modifyUser
in interface AmazonElastiCache
public ModifyUserGroupResult modifyUserGroup(ModifyUserGroupRequest request)
AmazonElastiCache
Changes the list of users that belong to the user group.
modifyUserGroup
in interface AmazonElastiCache
public ReservedCacheNode purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest request)
AmazonElastiCache
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis OSS or Managing Costs with Reserved Nodes for Memcached.
purchaseReservedCacheNodesOffering
in interface AmazonElastiCache
request
- Represents the input of a PurchaseReservedCacheNodesOffering
operation.public GlobalReplicationGroup rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request)
AmazonElastiCache
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroup
in interface AmazonElastiCache
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 OSS (cluster mode disabled) clusters. Rebooting is not supported on Redis OSS (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis OSS (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. A tag is a key-value pair
where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache
resources, with the exception of global replication group. When you add or remove tags on replication groups,
those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
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 startMigration(StartMigrationRequest request)
AmazonElastiCache
Start the migration of data.
startMigration
in interface AmazonElastiCache
public ReplicationGroup testFailover(TestFailoverRequest request)
AmazonElastiCache
Represents the input of a TestFailover
operation which tests automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon 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 OSS (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 Amazon 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 primary node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
testFailover
in interface AmazonElastiCache
public ReplicationGroup testMigration(TestMigrationRequest request)
AmazonElastiCache
Async API to test connection between source and target replication group.
testMigration
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