@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ElastiCacheAsyncClient extends AwsClient
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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
A tag is a key-value pair where the key and value are case-sensitive.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
A tag is a key-value pair where the key and value are case-sensitive.
|
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.
|
default CompletableFuture<BatchApplyUpdateActionResponse> |
batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest)
Apply the service update.
|
default CompletableFuture<BatchApplyUpdateActionResponse> |
batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest)
Apply the service update.
|
default CompletableFuture<BatchStopUpdateActionResponse> |
batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest)
Stop the service update.
|
default CompletableFuture<BatchStopUpdateActionResponse> |
batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest)
Stop the service update.
|
static ElastiCacheAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ElastiCacheAsyncClient. |
default CompletableFuture<CompleteMigrationResponse> |
completeMigration(CompleteMigrationRequest completeMigrationRequest)
Complete the migration of data.
|
default CompletableFuture<CompleteMigrationResponse> |
completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest)
Complete the migration of data.
|
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<CreateGlobalReplicationGroupResponse> |
createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest)
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.
|
default CompletableFuture<CreateGlobalReplicationGroupResponse> |
createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest)
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.
|
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<CreateUserResponse> |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
For Redis engine version 6.0 onwards: Creates a Redis user.
|
default CompletableFuture<CreateUserResponse> |
createUser(CreateUserRequest createUserRequest)
For Redis engine version 6.0 onwards: Creates a Redis user.
|
default CompletableFuture<CreateUserGroupResponse> |
createUserGroup(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest)
For Redis engine version 6.0 onwards: Creates a Redis user group.
|
default CompletableFuture<CreateUserGroupResponse> |
createUserGroup(CreateUserGroupRequest createUserGroupRequest)
For Redis engine version 6.0 onwards: Creates a Redis user group.
|
default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> |
decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global datastore
|
default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> |
decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global datastore
|
default CompletableFuture<DecreaseReplicaCountResponse> |
decreaseReplicaCount(Consumer<DecreaseReplicaCountRequest.Builder> decreaseReplicaCountRequest)
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number
of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
|
default CompletableFuture<DecreaseReplicaCountResponse> |
decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest)
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number
of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
|
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<DeleteGlobalReplicationGroupResponse> |
deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest)
Deleting a Global datastore is a two-step process:
|
default CompletableFuture<DeleteGlobalReplicationGroupResponse> |
deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest)
Deleting a Global datastore is a two-step process:
|
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<DeleteUserResponse> |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
For Redis engine version 6.0 onwards: Deletes a user.
|
default CompletableFuture<DeleteUserResponse> |
deleteUser(DeleteUserRequest deleteUserRequest)
For Redis engine version 6.0 onwards: Deletes a user.
|
default CompletableFuture<DeleteUserGroupResponse> |
deleteUserGroup(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest)
For Redis engine version 6.0 onwards: Deletes a user group.
|
default CompletableFuture<DeleteUserGroupResponse> |
deleteUserGroup(DeleteUserGroupRequest deleteUserGroupRequest)
For Redis engine version 6.0 onwards: Deletes a user group.
|
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(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 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(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
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(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)
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(Consumer<DescribeCacheParametersRequest.Builder> 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(Consumer<DescribeCacheSecurityGroupsRequest.Builder> 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(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)
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(Consumer<DescribeEngineDefaultParametersRequest.Builder> 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(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
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<DescribeGlobalReplicationGroupsResponse> |
describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default CompletableFuture<DescribeGlobalReplicationGroupsResponse> |
describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeGlobalReplicationGroupsPublisher |
describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeGlobalReplicationGroupsPublisher |
describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
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(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)
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(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
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(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
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<DescribeServiceUpdatesResponse> |
describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
|
default CompletableFuture<DescribeServiceUpdatesResponse> |
describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeServiceUpdatesPublisher |
describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeServiceUpdatesPublisher |
describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
|
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(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default DescribeSnapshotsPublisher |
describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default CompletableFuture<DescribeUpdateActionsResponse> |
describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
|
default CompletableFuture<DescribeUpdateActionsResponse> |
describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
|
default DescribeUpdateActionsPublisher |
describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
|
default DescribeUpdateActionsPublisher |
describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
|
default CompletableFuture<DescribeUserGroupsResponse> |
describeUserGroups(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)
Returns a list of user groups.
|
default CompletableFuture<DescribeUserGroupsResponse> |
describeUserGroups(DescribeUserGroupsRequest describeUserGroupsRequest)
Returns a list of user groups.
|
default DescribeUserGroupsPublisher |
describeUserGroupsPaginator(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)
Returns a list of user groups.
|
default DescribeUserGroupsPublisher |
describeUserGroupsPaginator(DescribeUserGroupsRequest describeUserGroupsRequest)
Returns a list of user groups.
|
default CompletableFuture<DescribeUsersResponse> |
describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Returns a list of users.
|
default CompletableFuture<DescribeUsersResponse> |
describeUsers(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
|
default DescribeUsersPublisher |
describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Returns a list of users.
|
default DescribeUsersPublisher |
describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
|
default CompletableFuture<DisassociateGlobalReplicationGroupResponse> |
disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global datastore using the Global datastore name.
|
default CompletableFuture<DisassociateGlobalReplicationGroupResponse> |
disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global datastore using the Global datastore name.
|
default CompletableFuture<FailoverGlobalReplicationGroupResponse> |
failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a secondary region.
|
default CompletableFuture<FailoverGlobalReplicationGroupResponse> |
failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a secondary region.
|
default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> |
increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global datastore
|
default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> |
increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global datastore
|
default CompletableFuture<IncreaseReplicaCountResponse> |
increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest)
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number
of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
|
default CompletableFuture<IncreaseReplicaCountResponse> |
increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest)
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number
of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group.
|
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.
|
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.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags currently on a named resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags currently on a 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<ModifyGlobalReplicationGroupResponse> |
modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest)
Modifies the settings for a Global datastore.
|
default CompletableFuture<ModifyGlobalReplicationGroupResponse> |
modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest)
Modifies the settings for a Global datastore.
|
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)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among existing shards.
|
default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among existing shards.
|
default CompletableFuture<ModifyUserResponse> |
modifyUser(Consumer<ModifyUserRequest.Builder> modifyUserRequest)
Changes user password(s) and/or access string.
|
default CompletableFuture<ModifyUserResponse> |
modifyUser(ModifyUserRequest modifyUserRequest)
Changes user password(s) and/or access string.
|
default CompletableFuture<ModifyUserGroupResponse> |
modifyUserGroup(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest)
Changes the list of users that belong to the user group.
|
default CompletableFuture<ModifyUserGroupResponse> |
modifyUserGroup(ModifyUserGroupRequest modifyUserGroupRequest)
Changes the list of users that belong to the user group.
|
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<RebalanceSlotsInGlobalReplicationGroupResponse> |
rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
|
default CompletableFuture<RebalanceSlotsInGlobalReplicationGroupResponse> |
rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
|
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 ElastiCacheServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartMigrationResponse> |
startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest)
Start the migration of data.
|
default CompletableFuture<StartMigrationResponse> |
startMigration(StartMigrationRequest startMigrationRequest)
Start the migration of data.
|
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). |
default ElastiCacheAsyncWaiter |
waiter()
Create an instance of
ElastiCacheAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
addTagsToResourceRequest - Represents the input of an AddTagsToResource operation.available state.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceMessage.Builder to create a request.
Represents the input of an AddTagsToResource operation.available state.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.
This is a convenience which creates an instance of the AuthorizeCacheSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via AuthorizeCacheSecurityGroupIngressRequest.builder()
authorizeCacheSecurityGroupIngressRequest - A Consumer that will call methods on AuthorizeCacheSecurityGroupIngressMessage.Builder to
create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.default CompletableFuture<BatchApplyUpdateActionResponse> batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest)
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
batchApplyUpdateActionRequest - default CompletableFuture<BatchApplyUpdateActionResponse> batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest)
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
This is a convenience which creates an instance of the BatchApplyUpdateActionRequest.Builder avoiding the
need to create one manually via BatchApplyUpdateActionRequest.builder()
batchApplyUpdateActionRequest - A Consumer that will call methods on BatchApplyUpdateActionMessage.Builder to create a
request.default CompletableFuture<BatchStopUpdateActionResponse> batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest)
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
batchStopUpdateActionRequest - default CompletableFuture<BatchStopUpdateActionResponse> batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest)
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
This is a convenience which creates an instance of the BatchStopUpdateActionRequest.Builder avoiding the
need to create one manually via BatchStopUpdateActionRequest.builder()
batchStopUpdateActionRequest - A Consumer that will call methods on BatchStopUpdateActionMessage.Builder to create a
request.default CompletableFuture<CompleteMigrationResponse> completeMigration(CompleteMigrationRequest completeMigrationRequest)
Complete the migration of data.
completeMigrationRequest - available state.default CompletableFuture<CompleteMigrationResponse> completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest)
Complete the migration of data.
This is a convenience which creates an instance of the CompleteMigrationRequest.Builder avoiding the need
to create one manually via CompleteMigrationRequest.builder()
completeMigrationRequest - A Consumer that will call methods on CompleteMigrationMessage.Builder to create a request.available state.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.
This is a convenience which creates an instance of the CopySnapshotRequest.Builder avoiding the need to
create one manually via CopySnapshotRequest.builder()
copySnapshotRequest - A Consumer that will call methods on CopySnapshotMessage.Builder to create a request.
Represents the input of a CopySnapshotMessage operation.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.
This operation is not supported for Redis (cluster mode enabled) clusters.
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.
This operation is not supported for Redis (cluster mode enabled) clusters.
This is a convenience which creates an instance of the CreateCacheClusterRequest.Builder avoiding the
need to create one manually via CreateCacheClusterRequest.builder()
createCacheClusterRequest - A Consumer that will call methods on CreateCacheClusterMessage.Builder to create a
request. Represents the input of a CreateCacheCluster operation.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.
This is a convenience which creates an instance of the CreateCacheParameterGroupRequest.Builder avoiding
the need to create one manually via CreateCacheParameterGroupRequest.builder()
createCacheParameterGroupRequest - A Consumer that will call methods on CreateCacheParameterGroupMessage.Builder to create a
request. Represents the input of a CreateCacheParameterGroup operation.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.
This is a convenience which creates an instance of the CreateCacheSecurityGroupRequest.Builder avoiding
the need to create one manually via CreateCacheSecurityGroupRequest.builder()
createCacheSecurityGroupRequest - A Consumer that will call methods on CreateCacheSecurityGroupMessage.Builder to create a
request. Represents the input of a CreateCacheSecurityGroup operation.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).
This is a convenience which creates an instance of the CreateCacheSubnetGroupRequest.Builder avoiding the
need to create one manually via CreateCacheSubnetGroupRequest.builder()
createCacheSubnetGroupRequest - A Consumer that will call methods on CreateCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a CreateCacheSubnetGroup operation.default CompletableFuture<CreateGlobalReplicationGroupResponse> createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest)
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
createGlobalReplicationGroupRequest - available state.default CompletableFuture<CreateGlobalReplicationGroupResponse> createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest)
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
This is a convenience which creates an instance of the CreateGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via CreateGlobalReplicationGroupRequest.builder()
createGlobalReplicationGroupRequest - A Consumer that will call methods on CreateGlobalReplicationGroupMessage.Builder to create
a request.available state.default CompletableFuture<CreateReplicationGroupResponse> createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis (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 cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters 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.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
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 cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.
This is a convenience which creates an instance of the CreateReplicationGroupRequest.Builder avoiding the
need to create one manually via CreateReplicationGroupRequest.builder()
createReplicationGroupRequest - A Consumer that will call methods on CreateReplicationGroupMessage.Builder to create a
request. Represents the input of a CreateReplicationGroup operation.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.
This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to
create one manually via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on CreateSnapshotMessage.Builder to create a request.
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<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
createUserRequest - default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserMessage.Builder to create a request.default CompletableFuture<CreateUserGroupResponse> createUserGroup(CreateUserGroupRequest createUserGroupRequest)
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
createUserGroupRequest - default CompletableFuture<CreateUserGroupResponse> createUserGroup(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest)
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
This is a convenience which creates an instance of the CreateUserGroupRequest.Builder avoiding the need
to create one manually via CreateUserGroupRequest.builder()
createUserGroupRequest - A Consumer that will call methods on CreateUserGroupMessage.Builder to create a request.default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global datastore
decreaseNodeGroupsInGlobalReplicationGroupRequest - default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global datastore
This is a convenience which creates an instance of the
DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via
DecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
decreaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on
DecreaseNodeGroupsInGlobalReplicationGroupMessage.Builder to create a request.default CompletableFuture<DecreaseReplicaCountResponse> decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest)
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
decreaseReplicaCountRequest - available state.available state.default CompletableFuture<DecreaseReplicaCountResponse> decreaseReplicaCount(Consumer<DecreaseReplicaCountRequest.Builder> decreaseReplicaCountRequest)
Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
This is a convenience which creates an instance of the DecreaseReplicaCountRequest.Builder avoiding the
need to create one manually via DecreaseReplicaCountRequest.builder()
decreaseReplicaCountRequest - A Consumer that will call methods on DecreaseReplicaCountMessage.Builder to create a
request.available state.available state.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 is not valid for:
Redis (cluster mode enabled) clusters
Redis (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
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 is not valid for:
Redis (cluster mode enabled) clusters
Redis (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
This is a convenience which creates an instance of the DeleteCacheClusterRequest.Builder avoiding the
need to create one manually via DeleteCacheClusterRequest.builder()
deleteCacheClusterRequest - A Consumer that will call methods on DeleteCacheClusterMessage.Builder to create a
request. 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<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. You cannot delete the default cache parameter groups in your account.
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. You cannot delete the default cache parameter groups in your account.
This is a convenience which creates an instance of the DeleteCacheParameterGroupRequest.Builder avoiding
the need to create one manually via DeleteCacheParameterGroupRequest.builder()
deleteCacheParameterGroupRequest - A Consumer that will call methods on DeleteCacheParameterGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheParameterGroup operation.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.
This is a convenience which creates an instance of the DeleteCacheSecurityGroupRequest.Builder avoiding
the need to create one manually via DeleteCacheSecurityGroupRequest.builder()
deleteCacheSecurityGroupRequest - A Consumer that will call methods on DeleteCacheSecurityGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheSecurityGroup operation.default CompletableFuture<DeleteCacheSubnetGroupResponse> deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that 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 default cache subnet group or one that is associated with any clusters.
This is a convenience which creates an instance of the DeleteCacheSubnetGroupRequest.Builder avoiding the
need to create one manually via DeleteCacheSubnetGroupRequest.builder()
deleteCacheSubnetGroupRequest - A Consumer that will call methods on DeleteCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheSubnetGroup operation.default CompletableFuture<DeleteGlobalReplicationGroupResponse> deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest)
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary
cluster using RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when
deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
deleteGlobalReplicationGroupRequest - default CompletableFuture<DeleteGlobalReplicationGroupResponse> deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest)
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary
cluster using RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the
primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when
deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This is a convenience which creates an instance of the DeleteGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via DeleteGlobalReplicationGroupRequest.builder()
deleteGlobalReplicationGroupRequest - A Consumer that will call methods on DeleteGlobalReplicationGroupMessage.Builder to create
a request.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.
This is a convenience which creates an instance of the DeleteReplicationGroupRequest.Builder avoiding the
need to create one manually via DeleteReplicationGroupRequest.builder()
deleteReplicationGroupRequest - A Consumer that will call methods on DeleteReplicationGroupMessage.Builder to create a
request. 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<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.
This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to
create one manually via DeleteSnapshotRequest.builder()
deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotMessage.Builder to create a request.
Represents the input of a DeleteSnapshot operation.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
deleteUserRequest - default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserMessage.Builder to create a request.default CompletableFuture<DeleteUserGroupResponse> deleteUserGroup(DeleteUserGroupRequest deleteUserGroupRequest)
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
deleteUserGroupRequest - default CompletableFuture<DeleteUserGroupResponse> deleteUserGroup(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest)
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
This is a convenience which creates an instance of the DeleteUserGroupRequest.Builder avoiding the need
to create one manually via DeleteUserGroupRequest.builder()
deleteUserGroupRequest - A Consumer that will call methods on DeleteUserGroupMessage.Builder to create a request.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(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.
This is a convenience which creates an instance of the DescribeCacheClustersRequest.Builder avoiding the
need to create one manually via DescribeCacheClustersRequest.builder()
describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersMessage.Builder to create a
request. 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 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheClustersRequest.Builder avoiding the
need to create one manually via DescribeCacheClustersRequest.builder()
describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersMessage.Builder to create a
request. Represents the input of a DescribeCacheClusters 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(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
This is a convenience which creates an instance of the DescribeCacheEngineVersionsRequest.Builder
avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()
describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsMessage.Builder to create
a request. Represents the input of a DescribeCacheEngineVersions operation.default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions()
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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<DescribeCacheEngineVersionsRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheEngineVersionsRequest.Builder
avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()
describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsMessage.Builder to create
a request. Represents the input of a DescribeCacheEngineVersions 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(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.
This is a convenience which creates an instance of the DescribeCacheParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()
describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsMessage.Builder to create
a request. 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 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()
describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheParameterGroups 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.
This is a convenience which creates an instance of the DescribeCacheParametersRequest.Builder avoiding
the need to create one manually via DescribeCacheParametersRequest.builder()
describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersMessage.Builder to create a
request. Represents the input of a DescribeCacheParameters operation.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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 DescribeCacheParametersPublisher describeCacheParametersPaginator(Consumer<DescribeCacheParametersRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheParametersRequest.Builder avoiding
the need to create one manually via DescribeCacheParametersRequest.builder()
describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersMessage.Builder to create a
request. 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. This applicable only when you have ElastiCache in Classic setup
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. This applicable only when you have ElastiCache in Classic setup
This is a convenience which creates an instance of the DescribeCacheSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()
describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheSecurityGroups operation.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 applicable only when you have ElastiCache in Classic setup
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 DescribeCacheSecurityGroupsPublisher describeCacheSecurityGroupsPaginator(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. This applicable only when you have ElastiCache in Classic setup
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()
describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsMessage.Builder to create
a request. 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. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.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. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
This is a convenience which creates an instance of the DescribeCacheSubnetGroupsRequest.Builder avoiding
the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()
describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsMessage.Builder to create a
request. 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. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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 applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
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 applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheSubnetGroupsRequest.Builder avoiding
the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()
describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsMessage.Builder to create a
request. Represents the input of a DescribeCacheSubnetGroups 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.
This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersMessage.Builder to
create a request. Represents the input of a DescribeEngineDefaultParameters operation.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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersMessage.Builder to
create a request. 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(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.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
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 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input of a DescribeEvents operation.default CompletableFuture<DescribeGlobalReplicationGroupsResponse> describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
describeGlobalReplicationGroupsRequest - default CompletableFuture<DescribeGlobalReplicationGroupsResponse> describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
This is a convenience which creates an instance of the DescribeGlobalReplicationGroupsRequest.Builder
avoiding the need to create one manually via DescribeGlobalReplicationGroupsRequest.builder()
describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsMessage.Builder to
create a request.default DescribeGlobalReplicationGroupsPublisher describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.
describeGlobalReplicationGroupsRequest - default DescribeGlobalReplicationGroupsPublisher describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeGlobalReplicationGroupsRequest.Builder
avoiding the need to create one manually via DescribeGlobalReplicationGroupsRequest.builder()
describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsMessage.Builder to
create a request.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(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.
This is a convenience which creates an instance of the DescribeReplicationGroupsRequest.Builder avoiding
the need to create one manually via DescribeReplicationGroupsRequest.builder()
describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsMessage.Builder to create a
request. 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 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeReplicationGroupsRequest.Builder avoiding
the need to create one manually via DescribeReplicationGroupsRequest.builder()
describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsMessage.Builder to create a
request. Represents the input of a DescribeReplicationGroups 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(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
This is a convenience which creates an instance of the DescribeReservedCacheNodesRequest.Builder avoiding
the need to create one manually via DescribeReservedCacheNodesRequest.builder()
describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesMessage.Builder to create a
request. 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<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
This is a convenience which creates an instance of the DescribeReservedCacheNodesOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()
describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsMessage.Builder to
create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings()
Lists available reserved cache node offerings.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedCacheNodesOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()
describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsMessage.Builder to
create a request. Represents the input of a DescribeReservedCacheNodesOfferings 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(Consumer<DescribeReservedCacheNodesRequest.Builder> 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedCacheNodesRequest.Builder avoiding
the need to create one manually via DescribeReservedCacheNodesRequest.builder()
describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesMessage.Builder to create a
request. Represents the input of a DescribeReservedCacheNodes operation.default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
describeServiceUpdatesRequest - default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
This is a convenience which creates an instance of the DescribeServiceUpdatesRequest.Builder avoiding the
need to create one manually via DescribeServiceUpdatesRequest.builder()
describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesMessage.Builder to create a
request.default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.
describeServiceUpdatesRequest - default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.
This is a convenience which creates an instance of the DescribeServiceUpdatesRequest.Builder avoiding the
need to create one manually via DescribeServiceUpdatesRequest.builder()
describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesMessage.Builder to create a
request.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(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.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsMessage.Builder to create a request.
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 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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(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.
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsMessage.Builder to create a request.
Represents the input of a DescribeSnapshotsMessage operation.default CompletableFuture<DescribeUpdateActionsResponse> describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
describeUpdateActionsRequest - default CompletableFuture<DescribeUpdateActionsResponse> describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
This is a convenience which creates an instance of the DescribeUpdateActionsRequest.Builder avoiding the
need to create one manually via DescribeUpdateActionsRequest.builder()
describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsMessage.Builder to create a
request.default DescribeUpdateActionsPublisher describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.
describeUpdateActionsRequest - default DescribeUpdateActionsPublisher describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.
This is a convenience which creates an instance of the DescribeUpdateActionsRequest.Builder avoiding the
need to create one manually via DescribeUpdateActionsRequest.builder()
describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsMessage.Builder to create a
request.default CompletableFuture<DescribeUserGroupsResponse> describeUserGroups(DescribeUserGroupsRequest describeUserGroupsRequest)
Returns a list of user groups.
describeUserGroupsRequest - default CompletableFuture<DescribeUserGroupsResponse> describeUserGroups(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)
Returns a list of user groups.
This is a convenience which creates an instance of the DescribeUserGroupsRequest.Builder avoiding the
need to create one manually via DescribeUserGroupsRequest.builder()
describeUserGroupsRequest - A Consumer that will call methods on DescribeUserGroupsMessage.Builder to create a
request.default DescribeUserGroupsPublisher describeUserGroupsPaginator(DescribeUserGroupsRequest describeUserGroupsRequest)
Returns a list of user groups.
This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation.
describeUserGroupsRequest - default DescribeUserGroupsPublisher describeUserGroupsPaginator(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)
Returns a list of user groups.
This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeUserGroupsRequest.Builder avoiding the
need to create one manually via DescribeUserGroupsRequest.builder()
describeUserGroupsRequest - A Consumer that will call methods on DescribeUserGroupsMessage.Builder to create a
request.default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
describeUsersRequest - default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Returns a list of users.
This is a convenience which creates an instance of the DescribeUsersRequest.Builder avoiding the need to
create one manually via DescribeUsersRequest.builder()
describeUsersRequest - A Consumer that will call methods on DescribeUsersMessage.Builder to create a request.default DescribeUsersPublisher describeUsersPaginator(DescribeUsersRequest describeUsersRequest)
Returns a list of users.
This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation.
describeUsersRequest - default DescribeUsersPublisher describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)
Returns a list of users.
This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) 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 subscribe helper method
software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation.
This is a convenience which creates an instance of the DescribeUsersRequest.Builder avoiding the need to
create one manually via DescribeUsersRequest.builder()
describeUsersRequest - A Consumer that will call methods on DescribeUsersMessage.Builder to create a request.default CompletableFuture<DisassociateGlobalReplicationGroupResponse> disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
disassociateGlobalReplicationGroupRequest - default CompletableFuture<DisassociateGlobalReplicationGroupResponse> disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
This is a convenience which creates an instance of the DisassociateGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via DisassociateGlobalReplicationGroupRequest.builder()
disassociateGlobalReplicationGroupRequest - A Consumer that will call methods on DisassociateGlobalReplicationGroupMessage.Builder to
create a request.default CompletableFuture<FailoverGlobalReplicationGroupResponse> failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
failoverGlobalReplicationGroupRequest - default CompletableFuture<FailoverGlobalReplicationGroupResponse> failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
This is a convenience which creates an instance of the FailoverGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via FailoverGlobalReplicationGroupRequest.builder()
failoverGlobalReplicationGroupRequest - A Consumer that will call methods on FailoverGlobalReplicationGroupMessage.Builder to
create a request.default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global datastore
increaseNodeGroupsInGlobalReplicationGroupRequest - default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global datastore
This is a convenience which creates an instance of the
IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via
IncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
increaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on
IncreaseNodeGroupsInGlobalReplicationGroupMessage.Builder to create a request.default CompletableFuture<IncreaseReplicaCountResponse> increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest)
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
increaseReplicaCountRequest - available state.available state.default CompletableFuture<IncreaseReplicaCountResponse> increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest)
Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
This is a convenience which creates an instance of the IncreaseReplicaCountRequest.Builder avoiding the
need to create one manually via IncreaseReplicaCountRequest.builder()
increaseReplicaCountRequest - A Consumer that will call methods on IncreaseReplicaCountMessage.Builder to create a
request.available state.available state.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.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your
cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
returned by this operation.
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.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your
cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
returned by this operation.
This is a convenience which creates an instance of the ListAllowedNodeTypeModificationsRequest.Builder
avoiding the need to create one manually via ListAllowedNodeTypeModificationsRequest.builder()
listAllowedNodeTypeModificationsRequest - A Consumer that will call methods on ListAllowedNodeTypeModificationsMessage.Builder to
create a request. The input parameters for the ListAllowedNodeTypeModifications operation.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
If the cluster is not in the available state, ListTagsForResource returns an error.
listTagsForResourceRequest - The input parameters for the ListTagsForResource operation.available state.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.
If the cluster is not in the available state, ListTagsForResource returns an error.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceMessage.Builder to create a
request. The input parameters for the ListTagsForResource operation.available state.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.
This is a convenience which creates an instance of the ModifyCacheClusterRequest.Builder avoiding the
need to create one manually via ModifyCacheClusterRequest.builder()
modifyCacheClusterRequest - A Consumer that will call methods on ModifyCacheClusterMessage.Builder to create a
request. Represents the input of a ModifyCacheCluster operation.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.
This is a convenience which creates an instance of the ModifyCacheParameterGroupRequest.Builder avoiding
the need to create one manually via ModifyCacheParameterGroupRequest.builder()
modifyCacheParameterGroupRequest - A Consumer that will call methods on ModifyCacheParameterGroupMessage.Builder to create a
request. Represents the input of a ModifyCacheParameterGroup operation.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.
This is a convenience which creates an instance of the ModifyCacheSubnetGroupRequest.Builder avoiding the
need to create one manually via ModifyCacheSubnetGroupRequest.builder()
modifyCacheSubnetGroupRequest - A Consumer that will call methods on ModifyCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a ModifyCacheSubnetGroup operation.default CompletableFuture<ModifyGlobalReplicationGroupResponse> modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest)
Modifies the settings for a Global datastore.
modifyGlobalReplicationGroupRequest - default CompletableFuture<ModifyGlobalReplicationGroupResponse> modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest)
Modifies the settings for a Global datastore.
This is a convenience which creates an instance of the ModifyGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via ModifyGlobalReplicationGroupRequest.builder()
modifyGlobalReplicationGroupRequest - A Consumer that will call methods on ModifyGlobalReplicationGroupMessage.Builder to create
a request.default CompletableFuture<ModifyReplicationGroupResponse> modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)
Modifies the settings for a replication group.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
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.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.
This is a convenience which creates an instance of the ModifyReplicationGroupRequest.Builder avoiding the
need to create one manually via ModifyReplicationGroupRequest.builder()
modifyReplicationGroupRequest - A Consumer that will call methods on ModifyReplicationGroupMessage.Builder to create a
request. Represents the input of a ModifyReplicationGroups operation.available state.available state.default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
modifyReplicationGroupShardConfigurationRequest - Represents the input for a ModifyReplicationGroupShardConfiguration operation.available state.available state.default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
This is a convenience which creates an instance of the
ModifyReplicationGroupShardConfigurationRequest.Builder avoiding the need to create one manually via
ModifyReplicationGroupShardConfigurationRequest.builder()
modifyReplicationGroupShardConfigurationRequest - A Consumer that will call methods on
ModifyReplicationGroupShardConfigurationMessage.Builder to create a request. Represents the input
for a ModifyReplicationGroupShardConfiguration operation.available state.available state.default CompletableFuture<ModifyUserResponse> modifyUser(ModifyUserRequest modifyUserRequest)
Changes user password(s) and/or access string.
modifyUserRequest - default CompletableFuture<ModifyUserResponse> modifyUser(Consumer<ModifyUserRequest.Builder> modifyUserRequest)
Changes user password(s) and/or access string.
This is a convenience which creates an instance of the ModifyUserRequest.Builder avoiding the need to
create one manually via ModifyUserRequest.builder()
modifyUserRequest - A Consumer that will call methods on ModifyUserMessage.Builder to create a request.default CompletableFuture<ModifyUserGroupResponse> modifyUserGroup(ModifyUserGroupRequest modifyUserGroupRequest)
Changes the list of users that belong to the user group.
modifyUserGroupRequest - default CompletableFuture<ModifyUserGroupResponse> modifyUserGroup(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest)
Changes the list of users that belong to the user group.
This is a convenience which creates an instance of the ModifyUserGroupRequest.Builder avoiding the need
to create one manually via ModifyUserGroupRequest.builder()
modifyUserGroupRequest - A Consumer that will call methods on ModifyUserGroupMessage.Builder to create a request.default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
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. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
This is a convenience which creates an instance of the PurchaseReservedCacheNodesOfferingRequest.Builder
avoiding the need to create one manually via PurchaseReservedCacheNodesOfferingRequest.builder()
purchaseReservedCacheNodesOfferingRequest - A Consumer that will call methods on PurchaseReservedCacheNodesOfferingMessage.Builder to
create a request. Represents the input of a PurchaseReservedCacheNodesOffering operation.default CompletableFuture<RebalanceSlotsInGlobalReplicationGroupResponse> rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroupRequest - default CompletableFuture<RebalanceSlotsInGlobalReplicationGroupResponse> rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
This is a convenience which creates an instance of the
RebalanceSlotsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via
RebalanceSlotsInGlobalReplicationGroupRequest.builder()
rebalanceSlotsInGlobalReplicationGroupRequest - A Consumer that will call methods on RebalanceSlotsInGlobalReplicationGroupMessage.Builder
to create a request.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.
This is a convenience which creates an instance of the RebootCacheClusterRequest.Builder avoiding the
need to create one manually via RebootCacheClusterRequest.builder()
rebootCacheClusterRequest - A Consumer that will call methods on RebootCacheClusterMessage.Builder to create a
request. Represents the input of a RebootCacheCluster operation.available state.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair
where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache
resources, with the exception of global replication group. When you add or remove tags on replication groups,
those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
removeTagsFromResourceRequest - Represents the input of a RemoveTagsFromResource operation.available state.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair
where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache
resources, with the exception of global replication group. When you add or remove tags on replication groups,
those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceMessage.Builder to create a
request. Represents the input of a RemoveTagsFromResource operation.available state.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.
This is a convenience which creates an instance of the ResetCacheParameterGroupRequest.Builder avoiding
the need to create one manually via ResetCacheParameterGroupRequest.builder()
resetCacheParameterGroupRequest - A Consumer that will call methods on ResetCacheParameterGroupMessage.Builder to create a
request. Represents the input of a ResetCacheParameterGroup operation.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.
This is a convenience which creates an instance of the RevokeCacheSecurityGroupIngressRequest.Builder
avoiding the need to create one manually via RevokeCacheSecurityGroupIngressRequest.builder()
revokeCacheSecurityGroupIngressRequest - A Consumer that will call methods on RevokeCacheSecurityGroupIngressMessage.Builder to
create a request. Represents the input of a RevokeCacheSecurityGroupIngress operation.default CompletableFuture<StartMigrationResponse> startMigration(StartMigrationRequest startMigrationRequest)
Start the migration of data.
startMigrationRequest - available state.default CompletableFuture<StartMigrationResponse> startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest)
Start the migration of data.
This is a convenience which creates an instance of the StartMigrationRequest.Builder avoiding the need to
create one manually via StartMigrationRequest.builder()
startMigrationRequest - A Consumer that will call methods on StartMigrationMessage.Builder to create a request.available state.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).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
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.TestFailover action is not available.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).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
This is a convenience which creates an instance of the TestFailoverRequest.Builder avoiding the need to
create one manually via TestFailoverRequest.builder()
testFailoverRequest - A Consumer that will call methods on TestFailoverMessage.Builder to create a request.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.TestFailover action is not available.default ElastiCacheAsyncWaiter waiter()
ElastiCacheAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
ElastiCacheAsyncWaiterdefault ElastiCacheServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic ElastiCacheAsyncClient create()
ElastiCacheAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElastiCacheAsyncClientBuilder builder()
ElastiCacheAsyncClient.Copyright © 2023. All rights reserved.