@Generated(value="software.amazon.awssdk:codegen") public interface ElastiCacheAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds up to 50 cost allocation tags to the named resource.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds up to 50 cost allocation tags to the named resource.
|
default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
Allows network ingress to a cache security group.
|
default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> |
authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest)
Allows network ingress to a cache security group.
|
static ElastiCacheAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ElastiCacheAsyncClient . |
default CompletableFuture<CopySnapshotResponse> |
copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
Makes a copy of an existing snapshot.
|
default CompletableFuture<CopySnapshotResponse> |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
Makes a copy of an existing snapshot.
|
static ElastiCacheAsyncClient |
create()
Create a
ElastiCacheAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateCacheClusterResponse> |
createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest)
Creates a cluster.
|
default CompletableFuture<CreateCacheClusterResponse> |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
Creates a cluster.
|
default CompletableFuture<CreateCacheParameterGroupResponse> |
createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest)
Creates a new Amazon ElastiCache cache parameter group.
|
default CompletableFuture<CreateCacheParameterGroupResponse> |
createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
Creates a new Amazon ElastiCache cache parameter group.
|
default CompletableFuture<CreateCacheSecurityGroupResponse> |
createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest)
Creates a new cache security group.
|
default CompletableFuture<CreateCacheSecurityGroupResponse> |
createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
Creates a new cache security group.
|
default CompletableFuture<CreateCacheSubnetGroupResponse> |
createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest)
Creates a new cache subnet group.
|
default CompletableFuture<CreateCacheSubnetGroupResponse> |
createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
Creates a new cache subnet group.
|
default CompletableFuture<CreateReplicationGroupResponse> |
createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest)
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
|
default CompletableFuture<CreateReplicationGroupResponse> |
createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a copy of an entire cluster or replication group at a specific moment in time.
|
default CompletableFuture<CreateSnapshotResponse> |
createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cluster or replication group at a specific moment in time.
|
default CompletableFuture<DeleteCacheClusterResponse> |
deleteCacheCluster(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteCacheClusterResponse> |
deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteCacheParameterGroupResponse> |
deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group.
|
default CompletableFuture<DeleteCacheParameterGroupResponse> |
deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group.
|
default CompletableFuture<DeleteCacheSecurityGroupResponse> |
deleteCacheSecurityGroup(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest)
Deletes a cache security group.
|
default CompletableFuture<DeleteCacheSecurityGroupResponse> |
deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
Deletes a cache security group.
|
default CompletableFuture<DeleteCacheSubnetGroupResponse> |
deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
|
default CompletableFuture<DeleteCacheSubnetGroupResponse> |
deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
|
default CompletableFuture<DeleteReplicationGroupResponse> |
deleteReplicationGroup(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest)
Deletes an existing replication group.
|
default CompletableFuture<DeleteReplicationGroupResponse> |
deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
Deletes an existing replication group.
|
default CompletableFuture<DeleteSnapshotResponse> |
deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes an existing snapshot.
|
default CompletableFuture<DeleteSnapshotResponse> |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes an existing snapshot.
|
default CompletableFuture<DescribeCacheClustersResponse> |
describeCacheClusters()
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default CompletableFuture<DescribeCacheClustersResponse> |
describeCacheClusters(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default CompletableFuture<DescribeCacheClustersResponse> |
describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default DescribeCacheClustersPublisher |
describeCacheClustersPaginator()
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default DescribeCacheClustersPublisher |
describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default CompletableFuture<DescribeCacheEngineVersionsResponse> |
describeCacheEngineVersions()
Returns a list of the available cache engines and their versions.
|
default CompletableFuture<DescribeCacheEngineVersionsResponse> |
describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default CompletableFuture<DescribeCacheEngineVersionsResponse> |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsPublisher |
describeCacheEngineVersionsPaginator()
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsPublisher |
describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default CompletableFuture<DescribeCacheParameterGroupsResponse> |
describeCacheParameterGroups()
Returns a list of cache parameter group descriptions.
|
default CompletableFuture<DescribeCacheParameterGroupsResponse> |
describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default CompletableFuture<DescribeCacheParameterGroupsResponse> |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsPublisher |
describeCacheParameterGroupsPaginator()
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsPublisher |
describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default CompletableFuture<DescribeCacheParametersResponse> |
describeCacheParameters(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
|
default CompletableFuture<DescribeCacheParametersResponse> |
describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
|
default DescribeCacheParametersPublisher |
describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
|
default CompletableFuture<DescribeCacheSecurityGroupsResponse> |
describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default CompletableFuture<DescribeCacheSecurityGroupsResponse> |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default DescribeCacheSecurityGroupsPublisher |
describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default CompletableFuture<DescribeCacheSubnetGroupsResponse> |
describeCacheSubnetGroups()
Returns a list of cache subnet group descriptions.
|
default CompletableFuture<DescribeCacheSubnetGroupsResponse> |
describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default CompletableFuture<DescribeCacheSubnetGroupsResponse> |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsPublisher |
describeCacheSubnetGroupsPaginator()
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsPublisher |
describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default CompletableFuture<DescribeEngineDefaultParametersResponse> |
describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default CompletableFuture<DescribeEngineDefaultParametersResponse> |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEngineDefaultParametersPublisher |
describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents()
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default DescribeEventsPublisher |
describeEventsPaginator()
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default DescribeEventsPublisher |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default CompletableFuture<DescribeReplicationGroupsResponse> |
describeReplicationGroups()
Returns information about a particular replication group.
|
default CompletableFuture<DescribeReplicationGroupsResponse> |
describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default CompletableFuture<DescribeReplicationGroupsResponse> |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default DescribeReplicationGroupsPublisher |
describeReplicationGroupsPaginator()
Returns information about a particular replication group.
|
default DescribeReplicationGroupsPublisher |
describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default CompletableFuture<DescribeReservedCacheNodesResponse> |
describeReservedCacheNodes()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default CompletableFuture<DescribeReservedCacheNodesResponse> |
describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default CompletableFuture<DescribeReservedCacheNodesResponse> |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> |
describeReservedCacheNodesOfferings()
Lists available reserved cache node offerings.
|
default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> |
describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsPublisher |
describeReservedCacheNodesOfferingsPaginator()
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsPublisher |
describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesPublisher |
describeReservedCacheNodesPaginator()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesPublisher |
describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots()
Returns information about cluster or replication group snapshots.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default CompletableFuture<DescribeSnapshotsResponse> |
describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default DescribeSnapshotsPublisher |
describeSnapshotsPaginator()
Returns information about cluster or replication group snapshots.
|
default DescribeSnapshotsPublisher |
describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default CompletableFuture<ListAllowedNodeTypeModificationsResponse> |
listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest)
Lists all available node types that you can scale your Redis cluster's or replication group's current node type
up to.
|
default CompletableFuture<ListAllowedNodeTypeModificationsResponse> |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
Lists all available node types that you can scale your Redis cluster's or replication group's current node type
up to.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all cost allocation tags currently on the named resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all cost allocation tags currently on the named resource.
|
default CompletableFuture<ModifyCacheClusterResponse> |
modifyCacheCluster(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest)
Modifies the settings for a cluster.
|
default CompletableFuture<ModifyCacheClusterResponse> |
modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
Modifies the settings for a cluster.
|
default CompletableFuture<ModifyCacheParameterGroupResponse> |
modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group.
|
default CompletableFuture<ModifyCacheParameterGroupResponse> |
modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group.
|
default CompletableFuture<ModifyCacheSubnetGroupResponse> |
modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
|
default CompletableFuture<ModifyCacheSubnetGroupResponse> |
modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
|
default CompletableFuture<ModifyReplicationGroupResponse> |
modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest)
Modifies the settings for a replication group.
|
default CompletableFuture<ModifyReplicationGroupResponse> |
modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
Modifies the settings for a replication group.
|
default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> |
modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest)
Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime.
|
default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime.
|
default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> |
purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
|
default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
|
default CompletableFuture<RebootCacheClusterResponse> |
rebootCacheCluster(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest)
Reboots some, or all, of the cache nodes within a provisioned cluster.
|
default CompletableFuture<RebootCacheClusterResponse> |
rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
Reboots some, or all, of the cache nodes within a provisioned cluster.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes the tags identified by the
TagKeys list from the named resource. |
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the
TagKeys list from the named resource. |
default CompletableFuture<ResetCacheParameterGroupResponse> |
resetCacheParameterGroup(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group to the engine or system default value.
|
default CompletableFuture<ResetCacheParameterGroupResponse> |
resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group to the engine or system default value.
|
default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> |
revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group.
|
default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group.
|
default CompletableFuture<TestFailoverResponse> |
testFailover(Consumer<TestFailoverRequest.Builder> testFailoverRequest)
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). |
default CompletableFuture<TestFailoverResponse> |
testFailover(TestFailoverRequest testFailoverRequest)
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). |
serviceName
close
static final String SERVICE_NAME
static ElastiCacheAsyncClient create()
ElastiCacheAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static ElastiCacheAsyncClientBuilder builder()
ElastiCacheAsyncClient
.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
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.
addTagsToResourceRequest
- Represents the input of an AddTagsToResource operation.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
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.
AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- a Consumer
that will call methods on AddTagsToResourceMessage.Builder
.default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
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.
authorizeCacheSecurityGroupIngressRequest
- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest)
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.
AuthorizeCacheSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via AuthorizeCacheSecurityGroupIngressRequest.builder()
authorizeCacheSecurityGroupIngressRequest
- a Consumer
that will call methods on AuthorizeCacheSecurityGroupIngressMessage.Builder
.default CompletableFuture<CopySnapshotResponse> copySnapshot(CopySnapshotRequest copySnapshotRequest)
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.
copySnapshotRequest
- Represents the input of a CopySnapshotMessage
operation.default CompletableFuture<CopySnapshotResponse> copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
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.
CopySnapshotRequest.Builder
avoiding the need to
create one manually via CopySnapshotRequest.builder()
copySnapshotRequest
- a Consumer
that will call methods on CopySnapshotMessage.Builder
.default CompletableFuture<CreateCacheClusterResponse> createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
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.
createCacheClusterRequest
- Represents the input of a CreateCacheCluster operation.available
state.default CompletableFuture<CreateCacheClusterResponse> createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest)
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.
CreateCacheClusterRequest.Builder
avoiding the
need to create one manually via CreateCacheClusterRequest.builder()
createCacheClusterRequest
- a Consumer
that will call methods on CreateCacheClusterMessage.Builder
.available
state.default CompletableFuture<CreateCacheParameterGroupResponse> createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)
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.
createCacheParameterGroupRequest
- Represents the input of a CreateCacheParameterGroup
operation.default CompletableFuture<CreateCacheParameterGroupResponse> createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest)
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.
CreateCacheParameterGroupRequest.Builder
avoiding
the need to create one manually via CreateCacheParameterGroupRequest.builder()
createCacheParameterGroupRequest
- a Consumer
that will call methods on CreateCacheParameterGroupMessage.Builder
.default CompletableFuture<CreateCacheSecurityGroupResponse> createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)
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.
createCacheSecurityGroupRequest
- Represents the input of a CreateCacheSecurityGroup
operation.default CompletableFuture<CreateCacheSecurityGroupResponse> createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest)
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.
CreateCacheSecurityGroupRequest.Builder
avoiding
the need to create one manually via CreateCacheSecurityGroupRequest.builder()
createCacheSecurityGroupRequest
- a Consumer
that will call methods on CreateCacheSecurityGroupMessage.Builder
.default CompletableFuture<CreateCacheSubnetGroupResponse> createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
createCacheSubnetGroupRequest
- Represents the input of a CreateCacheSubnetGroup
operation.default CompletableFuture<CreateCacheSubnetGroupResponse> createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest)
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
CreateCacheSubnetGroupRequest.Builder
avoiding the
need to create one manually via CreateCacheSubnetGroupRequest.builder()
createCacheSubnetGroupRequest
- a Consumer
that will call methods on CreateCacheSubnetGroupMessage.Builder
.default CompletableFuture<CreateReplicationGroupResponse> createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
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.
createReplicationGroupRequest
- Represents the input of a CreateReplicationGroup
operation.available
state.default CompletableFuture<CreateReplicationGroupResponse> createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest)
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.
CreateReplicationGroupRequest.Builder
avoiding the
need to create one manually via CreateReplicationGroupRequest.builder()
createReplicationGroupRequest
- a Consumer
that will call methods on CreateReplicationGroupMessage.Builder
.available
state.default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
createSnapshotRequest
- Represents the input of a CreateSnapshot
operation.available
state.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
CreateSnapshotRequest.Builder
avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest
- a Consumer
that will call methods on CreateSnapshotMessage.Builder
.available
state.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<DeleteCacheClusterResponse> deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)
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.
deleteCacheClusterRequest
- Represents the input of a DeleteCacheCluster
operation.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<DeleteCacheClusterResponse> deleteCacheCluster(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest)
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.
DeleteCacheClusterRequest.Builder
avoiding the
need to create one manually via DeleteCacheClusterRequest.builder()
deleteCacheClusterRequest
- a Consumer
that will call methods on DeleteCacheClusterMessage.Builder
.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<DeleteCacheParameterGroupResponse> deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
deleteCacheParameterGroupRequest
- Represents the input of a DeleteCacheParameterGroup
operation.default CompletableFuture<DeleteCacheParameterGroupResponse> deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
DeleteCacheParameterGroupRequest.Builder
avoiding
the need to create one manually via DeleteCacheParameterGroupRequest.builder()
deleteCacheParameterGroupRequest
- a Consumer
that will call methods on DeleteCacheParameterGroupMessage.Builder
.default CompletableFuture<DeleteCacheSecurityGroupResponse> deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
deleteCacheSecurityGroupRequest
- Represents the input of a DeleteCacheSecurityGroup
operation.default CompletableFuture<DeleteCacheSecurityGroupResponse> deleteCacheSecurityGroup(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest)
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
DeleteCacheSecurityGroupRequest.Builder
avoiding
the need to create one manually via DeleteCacheSecurityGroupRequest.builder()
deleteCacheSecurityGroupRequest
- a Consumer
that will call methods on DeleteCacheSecurityGroupMessage.Builder
.default CompletableFuture<DeleteCacheSubnetGroupResponse> deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any clusters.
deleteCacheSubnetGroupRequest
- Represents the input of a DeleteCacheSubnetGroup
operation.default CompletableFuture<DeleteCacheSubnetGroupResponse> deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any clusters.
DeleteCacheSubnetGroupRequest.Builder
avoiding the
need to create one manually via DeleteCacheSubnetGroupRequest.builder()
deleteCacheSubnetGroupRequest
- a Consumer
that will call methods on DeleteCacheSubnetGroupMessage.Builder
.default CompletableFuture<DeleteReplicationGroupResponse> deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)
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.
deleteReplicationGroupRequest
- Represents the input of a DeleteReplicationGroup
operation.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<DeleteReplicationGroupResponse> deleteReplicationGroup(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest)
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.
DeleteReplicationGroupRequest.Builder
avoiding the
need to create one manually via DeleteReplicationGroupRequest.builder()
deleteReplicationGroupRequest
- a Consumer
that will call methods on DeleteReplicationGroupMessage.Builder
.available
state.
Creating a snapshot of a Redis cluster running on a cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
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.
deleteSnapshotRequest
- Represents the input of a DeleteSnapshot
operation.default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
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.
DeleteSnapshotRequest.Builder
avoiding the need to
create one manually via DeleteSnapshotRequest.builder()
deleteSnapshotRequest
- a Consumer
that will call methods on DeleteSnapshotMessage.Builder
.default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)
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.
describeCacheClustersRequest
- Represents the input of a DescribeCacheClusters
operation.default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters()
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.
default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)
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.
DescribeCacheClustersRequest.Builder
avoiding the
need to create one manually via DescribeCacheClustersRequest.builder()
describeCacheClustersRequest
- a Consumer
that will call methods on DescribeCacheClustersMessage.Builder
.default DescribeCacheClustersPublisher describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest)
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.
This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
describeCacheClustersRequest
- Represents the input of a DescribeCacheClusters
operation.default DescribeCacheClustersPublisher describeCacheClustersPaginator()
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.
This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
describeCacheEngineVersionsRequest
- Represents the input of a DescribeCacheEngineVersions
operation.default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions()
Returns a list of the available cache engines and their versions.
default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
DescribeCacheEngineVersionsRequest.Builder
avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()
describeCacheEngineVersionsRequest
- a Consumer
that will call methods on DescribeCacheEngineVersionsMessage.Builder
.default DescribeCacheEngineVersionsPublisher describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
describeCacheEngineVersionsRequest
- Represents the input of a DescribeCacheEngineVersions
operation.default DescribeCacheEngineVersionsPublisher describeCacheEngineVersionsPaginator()
Returns a list of the available cache engines and their versions.
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
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.
describeCacheParameterGroupsRequest
- Represents the input of a DescribeCacheParameterGroups
operation.default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups()
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.
default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)
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.
DescribeCacheParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()
describeCacheParameterGroupsRequest
- a Consumer
that will call methods on DescribeCacheParameterGroupsMessage.Builder
.default DescribeCacheParameterGroupsPublisher describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
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.
This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
describeCacheParameterGroupsRequest
- Represents the input of a DescribeCacheParameterGroups
operation.default DescribeCacheParameterGroupsPublisher describeCacheParameterGroupsPaginator()
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.
This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
default CompletableFuture<DescribeCacheParametersResponse> describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersRequest
- Represents the input of a DescribeCacheParameters
operation.default CompletableFuture<DescribeCacheParametersResponse> describeCacheParameters(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
DescribeCacheParametersRequest.Builder
avoiding
the need to create one manually via DescribeCacheParametersRequest.builder()
describeCacheParametersRequest
- a Consumer
that will call methods on DescribeCacheParametersMessage.Builder
.default DescribeCacheParametersPublisher describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.
describeCacheParametersRequest
- Represents the input of a DescribeCacheParameters
operation.default CompletableFuture<DescribeCacheSecurityGroupsResponse> describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
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.
describeCacheSecurityGroupsRequest
- Represents the input of a DescribeCacheSecurityGroups
operation.default CompletableFuture<DescribeCacheSecurityGroupsResponse> describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)
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.
DescribeCacheSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()
describeCacheSecurityGroupsRequest
- a Consumer
that will call methods on DescribeCacheSecurityGroupsMessage.Builder
.default DescribeCacheSecurityGroupsPublisher describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
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 is a variant of
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.
describeCacheSecurityGroupsRequest
- Represents the input of a DescribeCacheSecurityGroups
operation.default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
describeCacheSubnetGroupsRequest
- Represents the input of a DescribeCacheSubnetGroups
operation.default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups()
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
DescribeCacheSubnetGroupsRequest.Builder
avoiding
the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()
describeCacheSubnetGroupsRequest
- a Consumer
that will call methods on DescribeCacheSubnetGroupsMessage.Builder
.default DescribeCacheSubnetGroupsPublisher describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
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 a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
describeCacheSubnetGroupsRequest
- Represents the input of a DescribeCacheSubnetGroups
operation.default DescribeCacheSubnetGroupsPublisher describeCacheSubnetGroupsPaginator()
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 a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersRequest
- Represents the input of a DescribeEngineDefaultParameters
operation.default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest
- a Consumer
that will call methods on DescribeEngineDefaultParametersMessage.Builder
.default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.
describeEngineDefaultParametersRequest
- Represents the input of a DescribeEngineDefaultParameters
operation.default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)
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.
describeEventsRequest
- Represents the input of a DescribeEvents
operation.default CompletableFuture<DescribeEventsResponse> describeEvents()
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.
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
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.
DescribeEventsRequest.Builder
avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest
- a Consumer
that will call methods on DescribeEventsMessage.Builder
.default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
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.
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation.
describeEventsRequest
- Represents the input of a DescribeEvents
operation.default DescribeEventsPublisher describeEventsPaginator()
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.
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation.
default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
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.
describeReplicationGroupsRequest
- Represents the input of a DescribeReplicationGroups
operation.default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups()
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.
default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)
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.
DescribeReplicationGroupsRequest.Builder
avoiding
the need to create one manually via DescribeReplicationGroupsRequest.builder()
describeReplicationGroupsRequest
- a Consumer
that will call methods on DescribeReplicationGroupsMessage.Builder
.default DescribeReplicationGroupsPublisher describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
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.
This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
describeReplicationGroupsRequest
- Represents the input of a DescribeReplicationGroups
operation.default DescribeReplicationGroupsPublisher describeReplicationGroupsPaginator()
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.
This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
describeReservedCacheNodesRequest
- Represents the input of a DescribeReservedCacheNodes
operation.default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
DescribeReservedCacheNodesRequest.Builder
avoiding
the need to create one manually via DescribeReservedCacheNodesRequest.builder()
describeReservedCacheNodesRequest
- a Consumer
that will call methods on DescribeReservedCacheNodesMessage.Builder
.default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest
- Represents the input of a DescribeReservedCacheNodesOfferings
operation.default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings()
Lists available reserved cache node offerings.
default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
DescribeReservedCacheNodesOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()
describeReservedCacheNodesOfferingsRequest
- a Consumer
that will call methods on DescribeReservedCacheNodesOfferingsMessage.Builder
.default DescribeReservedCacheNodesOfferingsPublisher describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
describeReservedCacheNodesOfferingsRequest
- Represents the input of a DescribeReservedCacheNodesOfferings
operation.default DescribeReservedCacheNodesOfferingsPublisher describeReservedCacheNodesOfferingsPaginator()
Lists available reserved cache node offerings.
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
default DescribeReservedCacheNodesPublisher describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
describeReservedCacheNodesRequest
- Represents the input of a DescribeReservedCacheNodes
operation.default DescribeReservedCacheNodesPublisher describeReservedCacheNodesPaginator()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)
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.
describeSnapshotsRequest
- Represents the input of a DescribeSnapshotsMessage
operation.default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots()
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.
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
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.
DescribeSnapshotsRequest.Builder
avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest
- a Consumer
that will call methods on DescribeSnapshotsMessage.Builder
.default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
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.
This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
describeSnapshotsRequest
- Represents the input of a DescribeSnapshotsMessage
operation.default DescribeSnapshotsPublisher describeSnapshotsPaginator()
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.
This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
default CompletableFuture<ListAllowedNodeTypeModificationsResponse> listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
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.
listAllowedNodeTypeModificationsRequest
- The input parameters for the ListAllowedNodeTypeModifications
operation.default CompletableFuture<ListAllowedNodeTypeModificationsResponse> listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest)
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.
ListAllowedNodeTypeModificationsRequest.Builder
avoiding the need to create one manually via ListAllowedNodeTypeModificationsRequest.builder()
listAllowedNodeTypeModificationsRequest
- a Consumer
that will call methods on ListAllowedNodeTypeModificationsMessage.Builder
.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest
- The input parameters for the ListTagsForResource
operation.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
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.
ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- a Consumer
that will call methods on ListTagsForResourceMessage.Builder
.default CompletableFuture<ModifyCacheClusterResponse> modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)
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.
modifyCacheClusterRequest
- Represents the input of a ModifyCacheCluster
operation.available
state.default CompletableFuture<ModifyCacheClusterResponse> modifyCacheCluster(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest)
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.
ModifyCacheClusterRequest.Builder
avoiding the
need to create one manually via ModifyCacheClusterRequest.builder()
modifyCacheClusterRequest
- a Consumer
that will call methods on ModifyCacheClusterMessage.Builder
.available
state.default CompletableFuture<ModifyCacheParameterGroupResponse> modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)
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.
modifyCacheParameterGroupRequest
- Represents the input of a ModifyCacheParameterGroup
operation.default CompletableFuture<ModifyCacheParameterGroupResponse> modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest)
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.
ModifyCacheParameterGroupRequest.Builder
avoiding
the need to create one manually via ModifyCacheParameterGroupRequest.builder()
modifyCacheParameterGroupRequest
- a Consumer
that will call methods on ModifyCacheParameterGroupMessage.Builder
.default CompletableFuture<ModifyCacheSubnetGroupResponse> modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
modifyCacheSubnetGroupRequest
- Represents the input of a ModifyCacheSubnetGroup
operation.default CompletableFuture<ModifyCacheSubnetGroupResponse> modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest)
Modifies an existing cache subnet group.
ModifyCacheSubnetGroupRequest.Builder
avoiding the
need to create one manually via ModifyCacheSubnetGroupRequest.builder()
modifyCacheSubnetGroupRequest
- a Consumer
that will call methods on ModifyCacheSubnetGroupMessage.Builder
.default CompletableFuture<ModifyReplicationGroupResponse> modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
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.
modifyReplicationGroupRequest
- Represents the input of a ModifyReplicationGroups
operation.available
state.available
state.default CompletableFuture<ModifyReplicationGroupResponse> modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest)
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.
ModifyReplicationGroupRequest.Builder
avoiding the
need to create one manually via ModifyReplicationGroupRequest.builder()
modifyReplicationGroupRequest
- a Consumer
that will call methods on ModifyReplicationGroupMessage.Builder
.available
state.available
state.default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
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
modifyReplicationGroupShardConfigurationRequest
- Represents the input for a ModifyReplicationGroupShardConfiguration
operation.available
state.available
state.default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest)
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
ModifyReplicationGroupShardConfigurationRequest.Builder
avoiding the need to create one manually via
ModifyReplicationGroupShardConfigurationRequest.builder()
modifyReplicationGroupShardConfigurationRequest
- a Consumer
that will call methods on
ModifyReplicationGroupShardConfigurationMessage.Builder
.available
state.available
state.default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOfferingRequest
- Represents the input of a PurchaseReservedCacheNodesOffering
operation.default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
PurchaseReservedCacheNodesOfferingRequest.Builder
avoiding the need to create one manually via PurchaseReservedCacheNodesOfferingRequest.builder()
purchaseReservedCacheNodesOfferingRequest
- a Consumer
that will call methods on PurchaseReservedCacheNodesOfferingMessage.Builder
.default CompletableFuture<RebootCacheClusterResponse> rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)
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.
rebootCacheClusterRequest
- Represents the input of a RebootCacheCluster
operation.available
state.default CompletableFuture<RebootCacheClusterResponse> rebootCacheCluster(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest)
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.
RebootCacheClusterRequest.Builder
avoiding the
need to create one manually via RebootCacheClusterRequest.builder()
rebootCacheClusterRequest
- a Consumer
that will call methods on RebootCacheClusterMessage.Builder
.available
state.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the TagKeys
list from the named resource.
removeTagsFromResourceRequest
- Represents the input of a RemoveTagsFromResource
operation.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes the tags identified by the TagKeys
list from the named resource.
RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- a Consumer
that will call methods on RemoveTagsFromResourceMessage.Builder
.default CompletableFuture<ResetCacheParameterGroupResponse> resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)
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.
resetCacheParameterGroupRequest
- Represents the input of a ResetCacheParameterGroup
operation.default CompletableFuture<ResetCacheParameterGroupResponse> resetCacheParameterGroup(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest)
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.
ResetCacheParameterGroupRequest.Builder
avoiding
the need to create one manually via ResetCacheParameterGroupRequest.builder()
resetCacheParameterGroupRequest
- a Consumer
that will call methods on ResetCacheParameterGroupMessage.Builder
.default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
revokeCacheSecurityGroupIngressRequest
- Represents the input of a RevokeCacheSecurityGroupIngress
operation.default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
RevokeCacheSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via RevokeCacheSecurityGroupIngressRequest.builder()
revokeCacheSecurityGroupIngressRequest
- a Consumer
that will call methods on RevokeCacheSecurityGroupIngressMessage.Builder
.default CompletableFuture<TestFailoverResponse> testFailover(TestFailoverRequest testFailoverRequest)
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.
testFailoverRequest
- available
state.available
state.NodeGroupId
parameter could
not be found. Please verify that the node group exists and that you spelled the NodeGroupId
value correctly.default CompletableFuture<TestFailoverResponse> testFailover(Consumer<TestFailoverRequest.Builder> testFailoverRequest)
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.
TestFailoverRequest.Builder
avoiding the need to
create one manually via TestFailoverRequest.builder()
testFailoverRequest
- a Consumer
that will call methods on TestFailoverMessage.Builder
.available
state.available
state.NodeGroupId
parameter could
not be found. Please verify that the node group exists and that you spelled the NodeGroupId
value correctly.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.