Interface ElastiCacheClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddTagsToResourceResponse
addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) A tag is a key-value pair where the key and value are case-sensitive.default AddTagsToResourceResponse
addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) A tag is a key-value pair where the key and value are case-sensitive.authorizeCacheSecurityGroupIngress
(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest) Allows network ingress to a cache security group.authorizeCacheSecurityGroupIngress
(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) Allows network ingress to a cache security group.default BatchApplyUpdateActionResponse
batchApplyUpdateAction
(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest) Apply the service update.default BatchApplyUpdateActionResponse
batchApplyUpdateAction
(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest) Apply the service update.default BatchStopUpdateActionResponse
batchStopUpdateAction
(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest) Stop the service update.default BatchStopUpdateActionResponse
batchStopUpdateAction
(BatchStopUpdateActionRequest batchStopUpdateActionRequest) Stop the service update.static ElastiCacheClientBuilder
builder()
Create a builder that can be used to configure and create aElastiCacheClient
.default CompleteMigrationResponse
completeMigration
(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest) Complete the migration of data.default CompleteMigrationResponse
completeMigration
(CompleteMigrationRequest completeMigrationRequest) Complete the migration of data.copyServerlessCacheSnapshot
(Consumer<CopyServerlessCacheSnapshotRequest.Builder> copyServerlessCacheSnapshotRequest) Creates a copy of an existing serverless cache’s snapshot.copyServerlessCacheSnapshot
(CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest) Creates a copy of an existing serverless cache’s snapshot.default CopySnapshotResponse
copySnapshot
(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) Makes a copy of an existing snapshot.default CopySnapshotResponse
copySnapshot
(CopySnapshotRequest copySnapshotRequest) Makes a copy of an existing snapshot.static ElastiCacheClient
create()
Create aElastiCacheClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateCacheClusterResponse
createCacheCluster
(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest) Creates a cluster.default CreateCacheClusterResponse
createCacheCluster
(CreateCacheClusterRequest createCacheClusterRequest) Creates a cluster.createCacheParameterGroup
(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest) Creates a new Amazon ElastiCache cache parameter group.createCacheParameterGroup
(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) Creates a new Amazon ElastiCache cache parameter group.default CreateCacheSecurityGroupResponse
createCacheSecurityGroup
(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest) Creates a new cache security group.default CreateCacheSecurityGroupResponse
createCacheSecurityGroup
(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) Creates a new cache security group.default CreateCacheSubnetGroupResponse
createCacheSubnetGroup
(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest) Creates a new cache subnet group.default CreateCacheSubnetGroupResponse
createCacheSubnetGroup
(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) Creates a new cache subnet group.createGlobalReplicationGroup
(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest) Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.createGlobalReplicationGroup
(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest) Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.default CreateReplicationGroupResponse
createReplicationGroup
(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest) Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.default CreateReplicationGroupResponse
createReplicationGroup
(CreateReplicationGroupRequest createReplicationGroupRequest) Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.default CreateServerlessCacheResponse
createServerlessCache
(Consumer<CreateServerlessCacheRequest.Builder> createServerlessCacheRequest) Creates a serverless cache.default CreateServerlessCacheResponse
createServerlessCache
(CreateServerlessCacheRequest createServerlessCacheRequest) Creates a serverless cache.createServerlessCacheSnapshot
(Consumer<CreateServerlessCacheSnapshotRequest.Builder> createServerlessCacheSnapshotRequest) This API creates a copy of an entire ServerlessCache at a specific moment in time.createServerlessCacheSnapshot
(CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest) This API creates a copy of an entire ServerlessCache at a specific moment in time.default CreateSnapshotResponse
createSnapshot
(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) Creates a copy of an entire cluster or replication group at a specific moment in time.default CreateSnapshotResponse
createSnapshot
(CreateSnapshotRequest createSnapshotRequest) Creates a copy of an entire cluster or replication group at a specific moment in time.default CreateUserResponse
createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) For Redis engine version 6.0 onwards: Creates a Redis user.default CreateUserResponse
createUser
(CreateUserRequest createUserRequest) For Redis engine version 6.0 onwards: Creates a Redis user.default CreateUserGroupResponse
createUserGroup
(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest) For Redis engine version 6.0 onwards: Creates a Redis user group.default CreateUserGroupResponse
createUserGroup
(CreateUserGroupRequest createUserGroupRequest) For Redis engine version 6.0 onwards: Creates a Redis user group.decreaseNodeGroupsInGlobalReplicationGroup
(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest) Decreases the number of node groups in a Global datastoredecreaseNodeGroupsInGlobalReplicationGroup
(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest) Decreases the number of node groups in a Global datastoredefault 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 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 DeleteCacheClusterResponse
deleteCacheCluster
(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest) Deletes a previously provisioned cluster.default DeleteCacheClusterResponse
deleteCacheCluster
(DeleteCacheClusterRequest deleteCacheClusterRequest) Deletes a previously provisioned cluster.deleteCacheParameterGroup
(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest) Deletes the specified cache parameter group.deleteCacheParameterGroup
(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) Deletes the specified cache parameter group.default DeleteCacheSecurityGroupResponse
deleteCacheSecurityGroup
(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest) Deletes a cache security group.default DeleteCacheSecurityGroupResponse
deleteCacheSecurityGroup
(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) Deletes a cache security group.default DeleteCacheSubnetGroupResponse
deleteCacheSubnetGroup
(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest) Deletes a cache subnet group.default DeleteCacheSubnetGroupResponse
deleteCacheSubnetGroup
(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) Deletes a cache subnet group.deleteGlobalReplicationGroup
(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest) Deleting a Global datastore is a two-step process:deleteGlobalReplicationGroup
(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest) Deleting a Global datastore is a two-step process:default DeleteReplicationGroupResponse
deleteReplicationGroup
(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest) Deletes an existing replication group.default DeleteReplicationGroupResponse
deleteReplicationGroup
(DeleteReplicationGroupRequest deleteReplicationGroupRequest) Deletes an existing replication group.default DeleteServerlessCacheResponse
deleteServerlessCache
(Consumer<DeleteServerlessCacheRequest.Builder> deleteServerlessCacheRequest) Deletes a specified existing serverless cache.default DeleteServerlessCacheResponse
deleteServerlessCache
(DeleteServerlessCacheRequest deleteServerlessCacheRequest) Deletes a specified existing serverless cache.deleteServerlessCacheSnapshot
(Consumer<DeleteServerlessCacheSnapshotRequest.Builder> deleteServerlessCacheSnapshotRequest) Deletes an existing serverless cache snapshot.deleteServerlessCacheSnapshot
(DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest) Deletes an existing serverless cache snapshot.default DeleteSnapshotResponse
deleteSnapshot
(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) Deletes an existing snapshot.default DeleteSnapshotResponse
deleteSnapshot
(DeleteSnapshotRequest deleteSnapshotRequest) Deletes an existing snapshot.default DeleteUserResponse
deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) For Redis engine version 6.0 onwards: Deletes a user.default DeleteUserResponse
deleteUser
(DeleteUserRequest deleteUserRequest) For Redis engine version 6.0 onwards: Deletes a user.default DeleteUserGroupResponse
deleteUserGroup
(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest) For Redis engine version 6.0 onwards: Deletes a user group.default DeleteUserGroupResponse
deleteUserGroup
(DeleteUserGroupRequest deleteUserGroupRequest) For Redis engine version 6.0 onwards: Deletes a user group.default DescribeCacheClustersResponse
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 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 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 DescribeCacheClustersIterable
This is a variant ofdescribeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.default DescribeCacheClustersIterable
describeCacheClustersPaginator
(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest) This is a variant ofdescribeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.default DescribeCacheClustersIterable
describeCacheClustersPaginator
(DescribeCacheClustersRequest describeCacheClustersRequest) This is a variant ofdescribeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.Returns a list of the available cache engines and their versions.describeCacheEngineVersions
(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) Returns a list of the available cache engines and their versions.describeCacheEngineVersions
(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) Returns a list of the available cache engines and their versions.This is a variant ofdescribeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.describeCacheEngineVersionsPaginator
(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) This is a variant ofdescribeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.describeCacheEngineVersionsPaginator
(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) This is a variant ofdescribeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.Returns a list of cache parameter group descriptions.describeCacheParameterGroups
(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) Returns a list of cache parameter group descriptions.describeCacheParameterGroups
(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) Returns a list of cache parameter group descriptions.This is a variant ofdescribeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.describeCacheParameterGroupsPaginator
(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) This is a variant ofdescribeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.describeCacheParameterGroupsPaginator
(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) This is a variant ofdescribeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.default DescribeCacheParametersResponse
describeCacheParameters
(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) Returns the detailed parameter list for a particular cache parameter group.default DescribeCacheParametersResponse
describeCacheParameters
(DescribeCacheParametersRequest describeCacheParametersRequest) Returns the detailed parameter list for a particular cache parameter group.default DescribeCacheParametersIterable
describeCacheParametersPaginator
(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) This is a variant ofdescribeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.default DescribeCacheParametersIterable
describeCacheParametersPaginator
(DescribeCacheParametersRequest describeCacheParametersRequest) This is a variant ofdescribeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.describeCacheSecurityGroups
(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) Returns a list of cache security group descriptions.describeCacheSecurityGroups
(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) Returns a list of cache security group descriptions.describeCacheSecurityGroupsPaginator
(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) This is a variant ofdescribeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.describeCacheSecurityGroupsPaginator
(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) This is a variant ofdescribeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.Returns a list of cache subnet group descriptions.describeCacheSubnetGroups
(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) Returns a list of cache subnet group descriptions.describeCacheSubnetGroups
(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) Returns a list of cache subnet group descriptions.This is a variant ofdescribeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.describeCacheSubnetGroupsPaginator
(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) This is a variant ofdescribeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.describeCacheSubnetGroupsPaginator
(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) This is a variant ofdescribeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.describeEngineDefaultParameters
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified cache engine.describeEngineDefaultParameters
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified cache engine.describeEngineDefaultParametersPaginator
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.describeEngineDefaultParametersPaginator
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.default DescribeEventsResponse
Returns events related to clusters, cache security groups, and cache parameter groups.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to clusters, cache security groups, and cache parameter groups.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to clusters, cache security groups, and cache parameter groups.default DescribeEventsIterable
This is a variant ofdescribeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation.describeGlobalReplicationGroups
(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) Returns information about a particular global replication group.describeGlobalReplicationGroups
(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) Returns information about a particular global replication group.describeGlobalReplicationGroupsPaginator
(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) This is a variant ofdescribeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.describeGlobalReplicationGroupsPaginator
(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) This is a variant ofdescribeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.Returns information about a particular replication group.describeReplicationGroups
(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) Returns information about a particular replication group.describeReplicationGroups
(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) Returns information about a particular replication group.This is a variant ofdescribeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.describeReplicationGroupsPaginator
(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) This is a variant ofdescribeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.describeReplicationGroupsPaginator
(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) This is a variant ofdescribeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.Returns information about reserved cache nodes for this account, or about a specified reserved cache node.describeReservedCacheNodes
(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) Returns information about reserved cache nodes for this account, or about a specified reserved cache node.describeReservedCacheNodes
(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) Returns information about reserved cache nodes for this account, or about a specified reserved cache node.Lists available reserved cache node offerings.describeReservedCacheNodesOfferings
(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) Lists available reserved cache node offerings.describeReservedCacheNodesOfferings
(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) Lists available reserved cache node offerings.describeReservedCacheNodesOfferingsPaginator
(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) describeReservedCacheNodesOfferingsPaginator
(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) This is a variant ofdescribeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.describeReservedCacheNodesPaginator
(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) This is a variant ofdescribeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.describeReservedCacheNodesPaginator
(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) This is a variant ofdescribeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.default DescribeServerlessCachesResponse
describeServerlessCaches
(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) Returns information about a specific serverless cache.default DescribeServerlessCachesResponse
describeServerlessCaches
(DescribeServerlessCachesRequest describeServerlessCachesRequest) Returns information about a specific serverless cache.describeServerlessCacheSnapshots
(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) Returns information about serverless cache snapshots.describeServerlessCacheSnapshots
(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) Returns information about serverless cache snapshots.describeServerlessCacheSnapshotsPaginator
(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) This is a variant ofdescribeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation.describeServerlessCacheSnapshotsPaginator
(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) This is a variant ofdescribeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation.default DescribeServerlessCachesIterable
describeServerlessCachesPaginator
(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) This is a variant ofdescribeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation.default DescribeServerlessCachesIterable
describeServerlessCachesPaginator
(DescribeServerlessCachesRequest describeServerlessCachesRequest) This is a variant ofdescribeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation.default DescribeServiceUpdatesResponse
describeServiceUpdates
(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) Returns details of the service updatesdefault DescribeServiceUpdatesResponse
describeServiceUpdates
(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) Returns details of the service updatesdefault DescribeServiceUpdatesIterable
describeServiceUpdatesPaginator
(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) This is a variant ofdescribeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.default DescribeServiceUpdatesIterable
describeServiceUpdatesPaginator
(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) This is a variant ofdescribeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.default DescribeSnapshotsResponse
Returns information about cluster or replication group snapshots.default DescribeSnapshotsResponse
describeSnapshots
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) Returns information about cluster or replication group snapshots.default DescribeSnapshotsResponse
describeSnapshots
(DescribeSnapshotsRequest describeSnapshotsRequest) Returns information about cluster or replication group snapshots.default DescribeSnapshotsIterable
This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.default DescribeSnapshotsIterable
describeSnapshotsPaginator
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.default DescribeSnapshotsIterable
describeSnapshotsPaginator
(DescribeSnapshotsRequest describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.default DescribeUpdateActionsResponse
describeUpdateActions
(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) Returns details of the update actionsdefault DescribeUpdateActionsResponse
describeUpdateActions
(DescribeUpdateActionsRequest describeUpdateActionsRequest) Returns details of the update actionsdefault DescribeUpdateActionsIterable
describeUpdateActionsPaginator
(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) This is a variant ofdescribeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.default DescribeUpdateActionsIterable
describeUpdateActionsPaginator
(DescribeUpdateActionsRequest describeUpdateActionsRequest) This is a variant ofdescribeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.default DescribeUserGroupsResponse
describeUserGroups
(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) Returns a list of user groups.default DescribeUserGroupsResponse
describeUserGroups
(DescribeUserGroupsRequest describeUserGroupsRequest) Returns a list of user groups.default DescribeUserGroupsIterable
describeUserGroupsPaginator
(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) This is a variant ofdescribeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation.default DescribeUserGroupsIterable
describeUserGroupsPaginator
(DescribeUserGroupsRequest describeUserGroupsRequest) This is a variant ofdescribeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation.default DescribeUsersResponse
describeUsers
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Returns a list of users.default DescribeUsersResponse
describeUsers
(DescribeUsersRequest describeUsersRequest) Returns a list of users.default DescribeUsersIterable
describeUsersPaginator
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)
operation.default DescribeUsersIterable
describeUsersPaginator
(DescribeUsersRequest describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)
operation.disassociateGlobalReplicationGroup
(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest) Remove a secondary cluster from the Global datastore using the Global datastore name.disassociateGlobalReplicationGroup
(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest) Remove a secondary cluster from the Global datastore using the Global datastore name.exportServerlessCacheSnapshot
(Consumer<ExportServerlessCacheSnapshotRequest.Builder> exportServerlessCacheSnapshotRequest) Provides the functionality to export the serverless cache snapshot data to Amazon S3.exportServerlessCacheSnapshot
(ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest) Provides the functionality to export the serverless cache snapshot data to Amazon S3.failoverGlobalReplicationGroup
(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest) Used to failover the primary region to a secondary region.failoverGlobalReplicationGroup
(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest) Used to failover the primary region to a secondary region.increaseNodeGroupsInGlobalReplicationGroup
(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest) Increase the number of node groups in the Global datastoreincreaseNodeGroupsInGlobalReplicationGroup
(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest) Increase the number of node groups in the Global datastoredefault 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 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.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.listAllowedNodeTypeModifications
(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) Lists all available node types that you can scale your Redis cluster's or replication group's current node type.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags currently on a named resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags currently on a named resource.default ModifyCacheClusterResponse
modifyCacheCluster
(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest) Modifies the settings for a cluster.default ModifyCacheClusterResponse
modifyCacheCluster
(ModifyCacheClusterRequest modifyCacheClusterRequest) Modifies the settings for a cluster.modifyCacheParameterGroup
(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest) Modifies the parameters of a cache parameter group.modifyCacheParameterGroup
(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) Modifies the parameters of a cache parameter group.default ModifyCacheSubnetGroupResponse
modifyCacheSubnetGroup
(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest) Modifies an existing cache subnet group.default ModifyCacheSubnetGroupResponse
modifyCacheSubnetGroup
(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) Modifies an existing cache subnet group.modifyGlobalReplicationGroup
(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest) Modifies the settings for a Global datastore.modifyGlobalReplicationGroup
(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest) Modifies the settings for a Global datastore.default ModifyReplicationGroupResponse
modifyReplicationGroup
(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest) Modifies the settings for a replication group.default ModifyReplicationGroupResponse
modifyReplicationGroup
(ModifyReplicationGroupRequest modifyReplicationGroupRequest) Modifies the settings for a replication group.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.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 ModifyServerlessCacheResponse
modifyServerlessCache
(Consumer<ModifyServerlessCacheRequest.Builder> modifyServerlessCacheRequest) This API modifies the attributes of a serverless cache.default ModifyServerlessCacheResponse
modifyServerlessCache
(ModifyServerlessCacheRequest modifyServerlessCacheRequest) This API modifies the attributes of a serverless cache.default ModifyUserResponse
modifyUser
(Consumer<ModifyUserRequest.Builder> modifyUserRequest) Changes user password(s) and/or access string.default ModifyUserResponse
modifyUser
(ModifyUserRequest modifyUserRequest) Changes user password(s) and/or access string.default ModifyUserGroupResponse
modifyUserGroup
(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest) Changes the list of users that belong to the user group.default ModifyUserGroupResponse
modifyUserGroup
(ModifyUserGroupRequest modifyUserGroupRequest) Changes the list of users that belong to the user group.purchaseReservedCacheNodesOffering
(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest) Allows you to purchase a reserved cache node offering.purchaseReservedCacheNodesOffering
(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) Allows you to purchase a reserved cache node offering.rebalanceSlotsInGlobalReplicationGroup
(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest) Redistribute slots to ensure uniform distribution across existing shards in the cluster.rebalanceSlotsInGlobalReplicationGroup
(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest) Redistribute slots to ensure uniform distribution across existing shards in the cluster.default RebootCacheClusterResponse
rebootCacheCluster
(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest) Reboots some, or all, of the cache nodes within a provisioned cluster.default RebootCacheClusterResponse
rebootCacheCluster
(RebootCacheClusterRequest rebootCacheClusterRequest) Reboots some, or all, of the cache nodes within a provisioned cluster.default RemoveTagsFromResourceResponse
removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes the tags identified by theTagKeys
list from the named resource.default RemoveTagsFromResourceResponse
removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes the tags identified by theTagKeys
list from the named resource.default ResetCacheParameterGroupResponse
resetCacheParameterGroup
(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest) Modifies the parameters of a cache parameter group to the engine or system default value.default ResetCacheParameterGroupResponse
resetCacheParameterGroup
(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) Modifies the parameters of a cache parameter group to the engine or system default value.revokeCacheSecurityGroupIngress
(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest) Revokes ingress from a cache security group.revokeCacheSecurityGroupIngress
(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) Revokes ingress from a cache security group.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartMigrationResponse
startMigration
(Consumer<StartMigrationRequest.Builder> startMigrationRequest) Start the migration of data.default StartMigrationResponse
startMigration
(StartMigrationRequest startMigrationRequest) Start the migration of data.default TestFailoverResponse
testFailover
(Consumer<TestFailoverRequest.Builder> testFailoverRequest) Represents the input of aTestFailover
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 TestFailoverResponse
testFailover
(TestFailoverRequest testFailoverRequest) Represents the input of aTestFailover
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 TestMigrationResponse
testMigration
(Consumer<TestMigrationRequest.Builder> testMigrationRequest) Async API to test connection between source and target replication group.default TestMigrationResponse
testMigration
(TestMigrationRequest testMigrationRequest) Async API to test connection between source and target replication group.default ElastiCacheWaiter
waiter()
Create an instance ofElastiCacheWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
addTagsToResourceRequest
- Represents the input of an AddTagsToResource operation.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request. Represents the input of an AddTagsToResource operation.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
authorizeCacheSecurityGroupIngress
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException, AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
authorizeCacheSecurityGroupIngressRequest
- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.- Returns:
- Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
- See Also:
-
authorizeCacheSecurityGroupIngress
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException, AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaAuthorizeCacheSecurityGroupIngressRequest.builder()
- Parameters:
authorizeCacheSecurityGroupIngressRequest
- AConsumer
that will call methods onAuthorizeCacheSecurityGroupIngressRequest.Builder
to create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.- Returns:
- Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
- See Also:
-
batchApplyUpdateAction
default BatchApplyUpdateActionResponse batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
- Parameters:
batchApplyUpdateActionRequest
-- Returns:
- Result of the BatchApplyUpdateAction operation returned by the service.
- See Also:
-
batchApplyUpdateAction
default BatchApplyUpdateActionResponse batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaBatchApplyUpdateActionRequest.builder()
- Parameters:
batchApplyUpdateActionRequest
- AConsumer
that will call methods onBatchApplyUpdateActionRequest.Builder
to create a request.- Returns:
- Result of the BatchApplyUpdateAction operation returned by the service.
- See Also:
-
batchStopUpdateAction
default BatchStopUpdateActionResponse batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
- Parameters:
batchStopUpdateActionRequest
-- Returns:
- Result of the BatchStopUpdateAction operation returned by the service.
- See Also:
-
batchStopUpdateAction
default BatchStopUpdateActionResponse batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaBatchStopUpdateActionRequest.builder()
- Parameters:
batchStopUpdateActionRequest
- AConsumer
that will call methods onBatchStopUpdateActionRequest.Builder
to create a request.- Returns:
- Result of the BatchStopUpdateAction operation returned by the service.
- See Also:
-
completeMigration
default CompleteMigrationResponse completeMigration(CompleteMigrationRequest completeMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException Complete the migration of data.
- Parameters:
completeMigrationRequest
-- Returns:
- Result of the CompleteMigration operation returned by the service.
- See Also:
-
completeMigration
default CompleteMigrationResponse completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException Complete the migration of data.
This is a convenience which creates an instance of the
CompleteMigrationRequest.Builder
avoiding the need to create one manually viaCompleteMigrationRequest.builder()
- Parameters:
completeMigrationRequest
- AConsumer
that will call methods onCompleteMigrationRequest.Builder
to create a request.- Returns:
- Result of the CompleteMigration operation returned by the service.
- See Also:
-
copyServerlessCacheSnapshot
default CopyServerlessCacheSnapshotResponse copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheSnapshotNotFoundException, ServerlessCacheSnapshotQuotaExceededException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
- Parameters:
copyServerlessCacheSnapshotRequest
-- Returns:
- Result of the CopyServerlessCacheSnapshot operation returned by the service.
- See Also:
-
copyServerlessCacheSnapshot
default CopyServerlessCacheSnapshotResponse copyServerlessCacheSnapshot(Consumer<CopyServerlessCacheSnapshotRequest.Builder> copyServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheSnapshotNotFoundException, ServerlessCacheSnapshotQuotaExceededException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
This is a convenience which creates an instance of the
CopyServerlessCacheSnapshotRequest.Builder
avoiding the need to create one manually viaCopyServerlessCacheSnapshotRequest.builder()
- Parameters:
copyServerlessCacheSnapshotRequest
- AConsumer
that will call methods onCopyServerlessCacheSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CopyServerlessCacheSnapshot operation returned by the service.
- See Also:
-
copySnapshot
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 theCopySnapshot
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 forTargetSnapshotName
. -
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.
- Parameters:
copySnapshotRequest
- Represents the input of aCopySnapshotMessage
operation.- Returns:
- Result of the CopySnapshot operation returned by the service.
- See Also:
-
-
copySnapshot
default CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 theCopySnapshot
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 forTargetSnapshotName
. -
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 viaCopySnapshotRequest.builder()
- Parameters:
copySnapshotRequest
- AConsumer
that will call methods onCopySnapshotRequest.Builder
to create a request. Represents the input of aCopySnapshotMessage
operation.- Returns:
- Result of the CopySnapshot operation returned by the service.
- See Also:
-
-
createCacheCluster
default CreateCacheClusterResponse createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
createCacheClusterRequest
- Represents the input of a CreateCacheCluster operation.- Returns:
- Result of the CreateCacheCluster operation returned by the service.
- See Also:
-
createCacheCluster
default CreateCacheClusterResponse createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateCacheClusterRequest.builder()
- Parameters:
createCacheClusterRequest
- AConsumer
that will call methods onCreateCacheClusterRequest.Builder
to create a request. Represents the input of a CreateCacheCluster operation.- Returns:
- Result of the CreateCacheCluster operation returned by the service.
- See Also:
-
createCacheParameterGroup
default CreateCacheParameterGroupResponse createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
createCacheParameterGroupRequest
- Represents the input of aCreateCacheParameterGroup
operation.- Returns:
- Result of the CreateCacheParameterGroup operation returned by the service.
- See Also:
-
-
createCacheParameterGroup
default CreateCacheParameterGroupResponse createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateCacheParameterGroupRequest.builder()
- Parameters:
createCacheParameterGroupRequest
- AConsumer
that will call methods onCreateCacheParameterGroupRequest.Builder
to create a request. Represents the input of aCreateCacheParameterGroup
operation.- Returns:
- Result of the CreateCacheParameterGroup operation returned by the service.
- See Also:
-
-
createCacheSecurityGroup
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
createCacheSecurityGroupRequest
- Represents the input of aCreateCacheSecurityGroup
operation.- Returns:
- Result of the CreateCacheSecurityGroup operation returned by the service.
- See Also:
-
createCacheSecurityGroup
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateCacheSecurityGroupRequest.builder()
- Parameters:
createCacheSecurityGroupRequest
- AConsumer
that will call methods onCreateCacheSecurityGroupRequest.Builder
to create a request. Represents the input of aCreateCacheSecurityGroup
operation.- Returns:
- Result of the CreateCacheSecurityGroup operation returned by the service.
- See Also:
-
createCacheSubnetGroup
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, TagQuotaPerResourceExceededException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
- Parameters:
createCacheSubnetGroupRequest
- Represents the input of aCreateCacheSubnetGroup
operation.- Returns:
- Result of the CreateCacheSubnetGroup operation returned by the service.
- See Also:
-
createCacheSubnetGroup
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, TagQuotaPerResourceExceededException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateCacheSubnetGroupRequest.builder()
- Parameters:
createCacheSubnetGroupRequest
- AConsumer
that will call methods onCreateCacheSubnetGroupRequest.Builder
to create a request. Represents the input of aCreateCacheSubnetGroup
operation.- Returns:
- Result of the CreateCacheSubnetGroup operation returned by the service.
- See Also:
-
createGlobalReplicationGroup
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, GlobalReplicationGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
createGlobalReplicationGroupRequest
-- Returns:
- Result of the CreateGlobalReplicationGroup operation returned by the service.
- See Also:
-
-
createGlobalReplicationGroup
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, GlobalReplicationGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateGlobalReplicationGroupRequest.builder()
- Parameters:
createGlobalReplicationGroupRequest
- AConsumer
that will call methods onCreateGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateGlobalReplicationGroup operation returned by the service.
- See Also:
-
-
createReplicationGroup
default CreateReplicationGroupResponse createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InvalidUserGroupStateException, UserGroupNotFoundException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis 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.
- Parameters:
createReplicationGroupRequest
- Represents the input of aCreateReplicationGroup
operation.- Returns:
- Result of the CreateReplicationGroup operation returned by the service.
- See Also:
-
createReplicationGroup
default CreateReplicationGroupResponse createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InvalidUserGroupStateException, UserGroupNotFoundException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis 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 viaCreateReplicationGroupRequest.builder()
- Parameters:
createReplicationGroupRequest
- AConsumer
that will call methods onCreateReplicationGroupRequest.Builder
to create a request. Represents the input of aCreateReplicationGroup
operation.- Returns:
- Result of the CreateReplicationGroup operation returned by the service.
- See Also:
-
createServerlessCache
default CreateServerlessCacheResponse createServerlessCache(CreateServerlessCacheRequest createServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheAlreadyExistsException, ServerlessCacheQuotaForCustomerExceededException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException Creates a serverless cache.
- Parameters:
createServerlessCacheRequest
-- Returns:
- Result of the CreateServerlessCache operation returned by the service.
- See Also:
-
createServerlessCache
default CreateServerlessCacheResponse createServerlessCache(Consumer<CreateServerlessCacheRequest.Builder> createServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheAlreadyExistsException, ServerlessCacheQuotaForCustomerExceededException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException Creates a serverless cache.
This is a convenience which creates an instance of the
CreateServerlessCacheRequest.Builder
avoiding the need to create one manually viaCreateServerlessCacheRequest.builder()
- Parameters:
createServerlessCacheRequest
- AConsumer
that will call methods onCreateServerlessCacheRequest.Builder
to create a request.- Returns:
- Result of the CreateServerlessCache operation returned by the service.
- See Also:
-
createServerlessCacheSnapshot
default CreateServerlessCacheSnapshotResponse createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotQuotaExceededException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.
- Parameters:
createServerlessCacheSnapshotRequest
-- Returns:
- Result of the CreateServerlessCacheSnapshot operation returned by the service.
- See Also:
-
createServerlessCacheSnapshot
default CreateServerlessCacheSnapshotResponse createServerlessCacheSnapshot(Consumer<CreateServerlessCacheSnapshotRequest.Builder> createServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotQuotaExceededException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.
This is a convenience which creates an instance of the
CreateServerlessCacheSnapshotRequest.Builder
avoiding the need to create one manually viaCreateServerlessCacheSnapshotRequest.builder()
- Parameters:
createServerlessCacheSnapshotRequest
- AConsumer
that will call methods onCreateServerlessCacheSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateServerlessCacheSnapshot operation returned by the service.
- See Also:
-
createSnapshot
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, TagQuotaPerResourceExceededException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
- Parameters:
createSnapshotRequest
- Represents the input of aCreateSnapshot
operation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- See Also:
-
createSnapshot
default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, TagQuotaPerResourceExceededException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateSnapshotRequest.builder()
- Parameters:
createSnapshotRequest
- AConsumer
that will call methods onCreateSnapshotRequest.Builder
to create a request. Represents the input of aCreateSnapshot
operation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws UserAlreadyExistsException, UserQuotaExceededException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws UserAlreadyExistsException, UserQuotaExceededException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUserGroup
default CreateUserGroupResponse createUserGroup(CreateUserGroupRequest createUserGroupRequest) throws UserNotFoundException, DuplicateUserNameException, UserGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, UserGroupQuotaExceededException, InvalidParameterValueException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
- Parameters:
createUserGroupRequest
-- Returns:
- Result of the CreateUserGroup operation returned by the service.
- See Also:
-
createUserGroup
default CreateUserGroupResponse createUserGroup(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest) throws UserNotFoundException, DuplicateUserNameException, UserGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, UserGroupQuotaExceededException, InvalidParameterValueException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaCreateUserGroupRequest.builder()
- Parameters:
createUserGroupRequest
- AConsumer
that will call methods onCreateUserGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateUserGroup operation returned by the service.
- See Also:
-
decreaseNodeGroupsInGlobalReplicationGroup
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Decreases the number of node groups in a Global datastore
- Parameters:
decreaseNodeGroupsInGlobalReplicationGroupRequest
-- Returns:
- Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
decreaseNodeGroupsInGlobalReplicationGroup
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
- Parameters:
decreaseNodeGroupsInGlobalReplicationGroupRequest
- AConsumer
that will call methods onDecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
decreaseReplicaCount
default DecreaseReplicaCountResponse decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
decreaseReplicaCountRequest
-- Returns:
- Result of the DecreaseReplicaCount operation returned by the service.
- See Also:
-
decreaseReplicaCount
default DecreaseReplicaCountResponse decreaseReplicaCount(Consumer<DecreaseReplicaCountRequest.Builder> decreaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDecreaseReplicaCountRequest.builder()
- Parameters:
decreaseReplicaCountRequest
- AConsumer
that will call methods onDecreaseReplicaCountRequest.Builder
to create a request.- Returns:
- Result of the DecreaseReplicaCount operation returned by the service.
- See Also:
-
deleteCacheCluster
default DeleteCacheClusterResponse deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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
- Parameters:
deleteCacheClusterRequest
- Represents the input of aDeleteCacheCluster
operation.- Returns:
- Result of the DeleteCacheCluster operation returned by the service.
- See Also:
-
-
deleteCacheCluster
default DeleteCacheClusterResponse deleteCacheCluster(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteCacheClusterRequest.builder()
- Parameters:
deleteCacheClusterRequest
- AConsumer
that will call methods onDeleteCacheClusterRequest.Builder
to create a request. Represents the input of aDeleteCacheCluster
operation.- Returns:
- Result of the DeleteCacheCluster operation returned by the service.
- See Also:
-
-
deleteCacheParameterGroup
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
deleteCacheParameterGroupRequest
- Represents the input of aDeleteCacheParameterGroup
operation.- Returns:
- Result of the DeleteCacheParameterGroup operation returned by the service.
- See Also:
-
deleteCacheParameterGroup
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteCacheParameterGroupRequest.builder()
- Parameters:
deleteCacheParameterGroupRequest
- AConsumer
that will call methods onDeleteCacheParameterGroupRequest.Builder
to create a request. Represents the input of aDeleteCacheParameterGroup
operation.- Returns:
- Result of the DeleteCacheParameterGroup operation returned by the service.
- See Also:
-
deleteCacheSecurityGroup
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
- Parameters:
deleteCacheSecurityGroupRequest
- Represents the input of aDeleteCacheSecurityGroup
operation.- Returns:
- Result of the DeleteCacheSecurityGroup operation returned by the service.
- See Also:
-
deleteCacheSecurityGroup
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteCacheSecurityGroupRequest.builder()
- Parameters:
deleteCacheSecurityGroupRequest
- AConsumer
that will call methods onDeleteCacheSecurityGroupRequest.Builder
to create a request. Represents the input of aDeleteCacheSecurityGroup
operation.- Returns:
- Result of the DeleteCacheSecurityGroup operation returned by the service.
- See Also:
-
deleteCacheSubnetGroup
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
- Parameters:
deleteCacheSubnetGroupRequest
- Represents the input of aDeleteCacheSubnetGroup
operation.- Returns:
- Result of the DeleteCacheSubnetGroup operation returned by the service.
- See Also:
-
deleteCacheSubnetGroup
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteCacheSubnetGroupRequest.builder()
- Parameters:
deleteCacheSubnetGroupRequest
- AConsumer
that will call methods onDeleteCacheSubnetGroupRequest.Builder
to create a request. Represents the input of aDeleteCacheSubnetGroup
operation.- Returns:
- Result of the DeleteCacheSubnetGroup operation returned by the service.
- See Also:
-
deleteGlobalReplicationGroup
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 usingRetainPrimaryReplicationGroup=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.
- Parameters:
deleteGlobalReplicationGroupRequest
-- Returns:
- Result of the DeleteGlobalReplicationGroup operation returned by the service.
- See Also:
-
-
deleteGlobalReplicationGroup
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 usingRetainPrimaryReplicationGroup=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 viaDeleteGlobalReplicationGroupRequest.builder()
- Parameters:
deleteGlobalReplicationGroupRequest
- AConsumer
that will call methods onDeleteGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGlobalReplicationGroup operation returned by the service.
- See Also:
-
-
deleteReplicationGroup
default DeleteReplicationGroupResponse deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
deleteReplicationGroupRequest
- Represents the input of aDeleteReplicationGroup
operation.- Returns:
- Result of the DeleteReplicationGroup operation returned by the service.
- See Also:
-
deleteReplicationGroup
default DeleteReplicationGroupResponse deleteReplicationGroup(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteReplicationGroupRequest.builder()
- Parameters:
deleteReplicationGroupRequest
- AConsumer
that will call methods onDeleteReplicationGroupRequest.Builder
to create a request. Represents the input of aDeleteReplicationGroup
operation.- Returns:
- Result of the DeleteReplicationGroup operation returned by the service.
- See Also:
-
deleteServerlessCache
default DeleteServerlessCacheResponse deleteServerlessCache(DeleteServerlessCacheRequest deleteServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException Deletes a specified existing serverless cache.
- Parameters:
deleteServerlessCacheRequest
-- Returns:
- Result of the DeleteServerlessCache operation returned by the service.
- See Also:
-
deleteServerlessCache
default DeleteServerlessCacheResponse deleteServerlessCache(Consumer<DeleteServerlessCacheRequest.Builder> deleteServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException Deletes a specified existing serverless cache.
This is a convenience which creates an instance of the
DeleteServerlessCacheRequest.Builder
avoiding the need to create one manually viaDeleteServerlessCacheRequest.builder()
- Parameters:
deleteServerlessCacheRequest
- AConsumer
that will call methods onDeleteServerlessCacheRequest.Builder
to create a request.- Returns:
- Result of the DeleteServerlessCache operation returned by the service.
- See Also:
-
deleteServerlessCacheSnapshot
default DeleteServerlessCacheSnapshotResponse deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest) throws ServiceLinkedRoleNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Deletes an existing serverless cache snapshot. Available for Redis only.
- Parameters:
deleteServerlessCacheSnapshotRequest
-- Returns:
- Result of the DeleteServerlessCacheSnapshot operation returned by the service.
- See Also:
-
deleteServerlessCacheSnapshot
default DeleteServerlessCacheSnapshotResponse deleteServerlessCacheSnapshot(Consumer<DeleteServerlessCacheSnapshotRequest.Builder> deleteServerlessCacheSnapshotRequest) throws ServiceLinkedRoleNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Deletes an existing serverless cache snapshot. Available for Redis only.
This is a convenience which creates an instance of the
DeleteServerlessCacheSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteServerlessCacheSnapshotRequest.builder()
- Parameters:
deleteServerlessCacheSnapshotRequest
- AConsumer
that will call methods onDeleteServerlessCacheSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteServerlessCacheSnapshot operation returned by the service.
- See Also:
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
deleteSnapshotRequest
- Represents the input of aDeleteSnapshot
operation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- See Also:
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteSnapshotRequest.builder()
- Parameters:
deleteSnapshotRequest
- AConsumer
that will call methods onDeleteSnapshotRequest.Builder
to create a request. Represents the input of aDeleteSnapshot
operation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws InvalidUserStateException, UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, DefaultUserAssociatedToUserGroupException, AwsServiceException, SdkClientException, ElastiCacheException 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).
- Parameters:
deleteUserRequest
-- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws InvalidUserStateException, UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, DefaultUserAssociatedToUserGroupException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
deleteUserGroup
default DeleteUserGroupResponse deleteUserGroup(DeleteUserGroupRequest deleteUserGroupRequest) throws UserGroupNotFoundException, InvalidUserGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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).
- Parameters:
deleteUserGroupRequest
-- Returns:
- Result of the DeleteUserGroup operation returned by the service.
- See Also:
-
deleteUserGroup
default DeleteUserGroupResponse deleteUserGroup(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest) throws UserGroupNotFoundException, InvalidUserGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDeleteUserGroupRequest.builder()
- Parameters:
deleteUserGroupRequest
- AConsumer
that will call methods onDeleteUserGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteUserGroup operation returned by the service.
- See Also:
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeCacheClustersRequest
- Represents the input of aDescribeCacheClusters
operation.- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- See Also:
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheClustersRequest.builder()
- Parameters:
describeCacheClustersRequest
- AConsumer
that will call methods onDescribeCacheClustersRequest.Builder
to create a request. Represents the input of aDescribeCacheClusters
operation.- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- See Also:
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters() throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns 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.
- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- See Also:
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator() throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheClustersRequest
- Represents the input of aDescribeCacheClusters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheClustersRequest.builder()
- Parameters:
describeCacheClustersRequest
- AConsumer
that will call methods onDescribeCacheClustersRequest.Builder
to create a request. Represents the input of aDescribeCacheClusters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException Returns a list of the available cache engines and their versions.
- Parameters:
describeCacheEngineVersionsRequest
- Represents the input of aDescribeCacheEngineVersions
operation.- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- See Also:
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheEngineVersionsRequest.builder()
- Parameters:
describeCacheEngineVersionsRequest
- AConsumer
that will call methods onDescribeCacheEngineVersionsRequest.Builder
to create a request. Represents the input of aDescribeCacheEngineVersions
operation.- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- See Also:
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions() throws AwsServiceException, SdkClientException, ElastiCacheExceptionReturns a list of the available cache engines and their versions.
- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- See Also:
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator() throws AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheEngineVersionsRequest
- Represents the input of aDescribeCacheEngineVersions
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheEngineVersionsRequest.builder()
- Parameters:
describeCacheEngineVersionsRequest
- AConsumer
that will call methods onDescribeCacheEngineVersionsRequest.Builder
to create a request. Represents the input of aDescribeCacheEngineVersions
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeCacheParameterGroupsRequest
- Represents the input of aDescribeCacheParameterGroups
operation.- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- See Also:
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheParameterGroupsRequest.builder()
- Parameters:
describeCacheParameterGroupsRequest
- AConsumer
that will call methods onDescribeCacheParameterGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheParameterGroups
operation.- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- See Also:
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups() throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- See Also:
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator() throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheParameterGroupsRequest
- Represents the input of aDescribeCacheParameterGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheParameterGroupsRequest.builder()
- Parameters:
describeCacheParameterGroupsRequest
- AConsumer
that will call methods onDescribeCacheParameterGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheParameterGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheParameters
default DescribeCacheParametersResponse describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns the detailed parameter list for a particular cache parameter group.
- Parameters:
describeCacheParametersRequest
- Represents the input of aDescribeCacheParameters
operation.- Returns:
- Result of the DescribeCacheParameters operation returned by the service.
- See Also:
-
describeCacheParameters
default DescribeCacheParametersResponse describeCacheParameters(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheParametersRequest.builder()
- Parameters:
describeCacheParametersRequest
- AConsumer
that will call methods onDescribeCacheParametersRequest.Builder
to create a request. Represents the input of aDescribeCacheParameters
operation.- Returns:
- Result of the DescribeCacheParameters operation returned by the service.
- See Also:
-
describeCacheParametersPaginator
default DescribeCacheParametersIterable describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client .describeCacheParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheParametersRequest
- Represents the input of aDescribeCacheParameters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheParametersPaginator
default DescribeCacheParametersIterable describeCacheParametersPaginator(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client .describeCacheParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheParametersRequest.builder()
- Parameters:
describeCacheParametersRequest
- AConsumer
that will call methods onDescribeCacheParametersRequest.Builder
to create a request. Represents the input of aDescribeCacheParameters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheSecurityGroups
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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
- Parameters:
describeCacheSecurityGroupsRequest
- Represents the input of aDescribeCacheSecurityGroups
operation.- Returns:
- Result of the DescribeCacheSecurityGroups operation returned by the service.
- See Also:
-
describeCacheSecurityGroups
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheSecurityGroupsRequest.builder()
- Parameters:
describeCacheSecurityGroupsRequest
- AConsumer
that will call methods onDescribeCacheSecurityGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheSecurityGroups
operation.- Returns:
- Result of the DescribeCacheSecurityGroups operation returned by the service.
- See Also:
-
describeCacheSecurityGroupsPaginator
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client .describeCacheSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheSecurityGroupsRequest
- Represents the input of aDescribeCacheSecurityGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheSecurityGroupsPaginator
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client .describeCacheSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheSecurityGroupsRequest.builder()
- Parameters:
describeCacheSecurityGroupsRequest
- AConsumer
that will call methods onDescribeCacheSecurityGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheSecurityGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeCacheSubnetGroupsRequest
- Represents the input of aDescribeCacheSubnetGroups
operation.- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- See Also:
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeCacheSubnetGroupsRequest.builder()
- Parameters:
describeCacheSubnetGroupsRequest
- AConsumer
that will call methods onDescribeCacheSubnetGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheSubnetGroups
operation.- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- See Also:
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups() throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns 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.
- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- See Also:
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator() throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeCacheSubnetGroupsRequest
- Represents the input of aDescribeCacheSubnetGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeCacheSubnetGroupsRequest.builder()
- Parameters:
describeCacheSubnetGroupsRequest
- AConsumer
that will call methods onDescribeCacheSubnetGroupsRequest.Builder
to create a request. Represents the input of aDescribeCacheSubnetGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns the default engine and system parameter information for the specified cache engine.
- Parameters:
describeEngineDefaultParametersRequest
- Represents the input of aDescribeEngineDefaultParameters
operation.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request. Represents the input of aDescribeEngineDefaultParameters
operation.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeEngineDefaultParametersRequest
- Represents the input of aDescribeEngineDefaultParameters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request. Represents the input of aDescribeEngineDefaultParameters
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeEventsRequest
- Represents the input of aDescribeEvents
operation.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Represents the input of aDescribeEvents
operation.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns 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.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeEventsRequest
- Represents the input of aDescribeEvents
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Represents the input of aDescribeEvents
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalReplicationGroups
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
- Parameters:
describeGlobalReplicationGroupsRequest
-- Returns:
- Result of the DescribeGlobalReplicationGroups operation returned by the service.
- See Also:
-
describeGlobalReplicationGroups
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeGlobalReplicationGroupsRequest.builder()
- Parameters:
describeGlobalReplicationGroupsRequest
- AConsumer
that will call methods onDescribeGlobalReplicationGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeGlobalReplicationGroups operation returned by the service.
- See Also:
-
describeGlobalReplicationGroupsPaginator
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client .describeGlobalReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeGlobalReplicationGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalReplicationGroupsPaginator
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client .describeGlobalReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeGlobalReplicationGroupsRequest.builder()
- Parameters:
describeGlobalReplicationGroupsRequest
- AConsumer
that will call methods onDescribeGlobalReplicationGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeReplicationGroupsRequest
- Represents the input of aDescribeReplicationGroups
operation.- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- See Also:
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeReplicationGroupsRequest.builder()
- Parameters:
describeReplicationGroupsRequest
- AConsumer
that will call methods onDescribeReplicationGroupsRequest.Builder
to create a request. Represents the input of aDescribeReplicationGroups
operation.- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- See Also:
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups() throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns 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.
- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- See Also:
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator() throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeReplicationGroupsRequest
- Represents the input of aDescribeReplicationGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeReplicationGroupsRequest.builder()
- Parameters:
describeReplicationGroupsRequest
- AConsumer
that will call methods onDescribeReplicationGroupsRequest.Builder
to create a request. Represents the input of aDescribeReplicationGroups
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
- Parameters:
describeReservedCacheNodesRequest
- Represents the input of aDescribeReservedCacheNodes
operation.- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- See Also:
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeReservedCacheNodesRequest.builder()
- Parameters:
describeReservedCacheNodesRequest
- AConsumer
that will call methods onDescribeReservedCacheNodesRequest.Builder
to create a request. Represents the input of aDescribeReservedCacheNodes
operation.- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- See Also:
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes() throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns information about reserved cache nodes for this account, or about a specified reserved cache node.
- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- See Also:
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator() throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeReservedCacheNodesRequest
- Represents the input of aDescribeReservedCacheNodes
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeReservedCacheNodesRequest.builder()
- Parameters:
describeReservedCacheNodesRequest
- AConsumer
that will call methods onDescribeReservedCacheNodesRequest.Builder
to create a request. Represents the input of aDescribeReservedCacheNodes
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Lists available reserved cache node offerings.
- Parameters:
describeReservedCacheNodesOfferingsRequest
- Represents the input of aDescribeReservedCacheNodesOfferings
operation.- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- See Also:
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeReservedCacheNodesOfferingsRequest.builder()
- Parameters:
describeReservedCacheNodesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedCacheNodesOfferingsRequest.Builder
to create a request. Represents the input of aDescribeReservedCacheNodesOfferings
operation.- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- See Also:
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionLists available reserved cache node offerings.
- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- See Also:
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeReservedCacheNodesOfferingsRequest
- Represents the input of aDescribeReservedCacheNodesOfferings
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeReservedCacheNodesOfferingsRequest.builder()
- Parameters:
describeReservedCacheNodesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedCacheNodesOfferingsRequest.Builder
to create a request. Represents the input of aDescribeReservedCacheNodesOfferings
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServerlessCacheSnapshots
default DescribeServerlessCacheSnapshotsResponse describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.
- Parameters:
describeServerlessCacheSnapshotsRequest
-- Returns:
- Result of the DescribeServerlessCacheSnapshots operation returned by the service.
- See Also:
-
describeServerlessCacheSnapshots
default DescribeServerlessCacheSnapshotsResponse describeServerlessCacheSnapshots(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.
This is a convenience which creates an instance of the
DescribeServerlessCacheSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeServerlessCacheSnapshotsRequest.builder()
- Parameters:
describeServerlessCacheSnapshotsRequest
- AConsumer
that will call methods onDescribeServerlessCacheSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the DescribeServerlessCacheSnapshots operation returned by the service.
- See Also:
-
describeServerlessCacheSnapshotsPaginator
default DescribeServerlessCacheSnapshotsIterable describeServerlessCacheSnapshotsPaginator(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client .describeServerlessCacheSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation.- Parameters:
describeServerlessCacheSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServerlessCacheSnapshotsPaginator
default DescribeServerlessCacheSnapshotsIterable describeServerlessCacheSnapshotsPaginator(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client .describeServerlessCacheSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeServerlessCacheSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeServerlessCacheSnapshotsRequest.builder()
- Parameters:
describeServerlessCacheSnapshotsRequest
- AConsumer
that will call methods onDescribeServerlessCacheSnapshotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServerlessCaches
default DescribeServerlessCachesResponse describeServerlessCaches(DescribeServerlessCachesRequest describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
- Parameters:
describeServerlessCachesRequest
-- Returns:
- Result of the DescribeServerlessCaches operation returned by the service.
- See Also:
-
describeServerlessCaches
default DescribeServerlessCachesResponse describeServerlessCaches(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeServerlessCachesRequest.Builder
avoiding the need to create one manually viaDescribeServerlessCachesRequest.builder()
- Parameters:
describeServerlessCachesRequest
- AConsumer
that will call methods onDescribeServerlessCachesRequest.Builder
to create a request.- Returns:
- Result of the DescribeServerlessCaches operation returned by the service.
- See Also:
-
describeServerlessCachesPaginator
default DescribeServerlessCachesIterable describeServerlessCachesPaginator(DescribeServerlessCachesRequest describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client .describeServerlessCachesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation.- Parameters:
describeServerlessCachesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServerlessCachesPaginator
default DescribeServerlessCachesIterable describeServerlessCachesPaginator(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client .describeServerlessCachesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)
operation.
This is a convenience which creates an instance of the
DescribeServerlessCachesRequest.Builder
avoiding the need to create one manually viaDescribeServerlessCachesRequest.builder()
- Parameters:
describeServerlessCachesRequest
- AConsumer
that will call methods onDescribeServerlessCachesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServiceUpdates
default DescribeServiceUpdatesResponse describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns details of the service updates
- Parameters:
describeServiceUpdatesRequest
-- Returns:
- Result of the DescribeServiceUpdates operation returned by the service.
- See Also:
-
describeServiceUpdates
default DescribeServiceUpdatesResponse describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeServiceUpdatesRequest.builder()
- Parameters:
describeServiceUpdatesRequest
- AConsumer
that will call methods onDescribeServiceUpdatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeServiceUpdates operation returned by the service.
- See Also:
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client .describeServiceUpdatesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeServiceUpdatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client .describeServiceUpdatesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeServiceUpdatesRequest.builder()
- Parameters:
describeServiceUpdatesRequest
- AConsumer
that will call methods onDescribeServiceUpdatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
describeSnapshotsRequest
- Represents the input of aDescribeSnapshotsMessage
operation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- See Also:
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request. Represents the input of aDescribeSnapshotsMessage
operation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- See Also:
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots() throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionReturns 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.
- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator() throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheExceptionThis is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeSnapshotsRequest
- Represents the input of aDescribeSnapshotsMessage
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request. Represents the input of aDescribeSnapshotsMessage
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUpdateActions
default DescribeUpdateActionsResponse describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns details of the update actions
- Parameters:
describeUpdateActionsRequest
-- Returns:
- Result of the DescribeUpdateActions operation returned by the service.
- See Also:
-
describeUpdateActions
default DescribeUpdateActionsResponse describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeUpdateActionsRequest.builder()
- Parameters:
describeUpdateActionsRequest
- AConsumer
that will call methods onDescribeUpdateActionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeUpdateActions operation returned by the service.
- See Also:
-
describeUpdateActionsPaginator
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client .describeUpdateActionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeUpdateActionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUpdateActionsPaginator
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client .describeUpdateActionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeUpdateActionsRequest.builder()
- Parameters:
describeUpdateActionsRequest
- AConsumer
that will call methods onDescribeUpdateActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUserGroups
default DescribeUserGroupsResponse describeUserGroups(DescribeUserGroupsRequest describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns a list of user groups.
- Parameters:
describeUserGroupsRequest
-- Returns:
- Result of the DescribeUserGroups operation returned by the service.
- See Also:
-
describeUserGroups
default DescribeUserGroupsResponse describeUserGroups(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDescribeUserGroupsRequest.builder()
- Parameters:
describeUserGroupsRequest
- AConsumer
that will call methods onDescribeUserGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeUserGroups operation returned by the service.
- See Also:
-
describeUserGroupsPaginator
default DescribeUserGroupsIterable describeUserGroupsPaginator(DescribeUserGroupsRequest describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client .describeUserGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeUserGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUserGroupsPaginator
default DescribeUserGroupsIterable describeUserGroupsPaginator(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client .describeUserGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeUserGroupsRequest.builder()
- Parameters:
describeUserGroupsRequest
- AConsumer
that will call methods onDescribeUserGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsers
default DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns a list of users.
- Parameters:
describeUsersRequest
-- Returns:
- Result of the DescribeUsers operation returned by the service.
- See Also:
-
describeUsers
default DescribeUsersResponse describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Returns a list of users.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- Result of the DescribeUsers operation returned by the service.
- See Also:
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(DescribeUsersRequest describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client .describeUsersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeUsersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client .describeUsersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
disassociateGlobalReplicationGroup
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
disassociateGlobalReplicationGroupRequest
-- Returns:
- Result of the DisassociateGlobalReplicationGroup operation returned by the service.
- See Also:
-
disassociateGlobalReplicationGroup
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaDisassociateGlobalReplicationGroupRequest.builder()
- Parameters:
disassociateGlobalReplicationGroupRequest
- AConsumer
that will call methods onDisassociateGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the DisassociateGlobalReplicationGroup operation returned by the service.
- See Also:
-
exportServerlessCacheSnapshot
default ExportServerlessCacheSnapshotResponse exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only.
- Parameters:
exportServerlessCacheSnapshotRequest
-- Returns:
- Result of the ExportServerlessCacheSnapshot operation returned by the service.
- See Also:
-
exportServerlessCacheSnapshot
default ExportServerlessCacheSnapshotResponse exportServerlessCacheSnapshot(Consumer<ExportServerlessCacheSnapshotRequest.Builder> exportServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only.
This is a convenience which creates an instance of the
ExportServerlessCacheSnapshotRequest.Builder
avoiding the need to create one manually viaExportServerlessCacheSnapshotRequest.builder()
- Parameters:
exportServerlessCacheSnapshotRequest
- AConsumer
that will call methods onExportServerlessCacheSnapshotRequest.Builder
to create a request.- Returns:
- Result of the ExportServerlessCacheSnapshot operation returned by the service.
- See Also:
-
failoverGlobalReplicationGroup
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
- Parameters:
failoverGlobalReplicationGroupRequest
-- Returns:
- Result of the FailoverGlobalReplicationGroup operation returned by the service.
- See Also:
-
failoverGlobalReplicationGroup
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaFailoverGlobalReplicationGroupRequest.builder()
- Parameters:
failoverGlobalReplicationGroupRequest
- AConsumer
that will call methods onFailoverGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the FailoverGlobalReplicationGroup operation returned by the service.
- See Also:
-
increaseNodeGroupsInGlobalReplicationGroup
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Increase the number of node groups in the Global datastore
- Parameters:
increaseNodeGroupsInGlobalReplicationGroupRequest
-- Returns:
- Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
increaseNodeGroupsInGlobalReplicationGroup
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaIncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
- Parameters:
increaseNodeGroupsInGlobalReplicationGroupRequest
- AConsumer
that will call methods onIncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
increaseReplicaCount
default IncreaseReplicaCountResponse increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
increaseReplicaCountRequest
-- Returns:
- Result of the IncreaseReplicaCount operation returned by the service.
- See Also:
-
increaseReplicaCount
default IncreaseReplicaCountResponse increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaIncreaseReplicaCountRequest.builder()
- Parameters:
increaseReplicaCountRequest
- AConsumer
that will call methods onIncreaseReplicaCountRequest.Builder
to create a request.- Returns:
- Result of the IncreaseReplicaCount operation returned by the service.
- See Also:
-
listAllowedNodeTypeModifications
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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
orModifyReplicationGroup
operations to scale your cluster or replication group, the value of theCacheNodeType
parameter must be one of the node types returned by this operation.- Parameters:
listAllowedNodeTypeModificationsRequest
- The input parameters for theListAllowedNodeTypeModifications
operation.- Returns:
- Result of the ListAllowedNodeTypeModifications operation returned by the service.
- See Also:
-
listAllowedNodeTypeModifications
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest) throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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
orModifyReplicationGroup
operations to scale your cluster or replication group, the value of theCacheNodeType
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 viaListAllowedNodeTypeModificationsRequest.builder()
- Parameters:
listAllowedNodeTypeModificationsRequest
- AConsumer
that will call methods onListAllowedNodeTypeModificationsRequest.Builder
to create a request. The input parameters for theListAllowedNodeTypeModifications
operation.- Returns:
- Result of the ListAllowedNodeTypeModifications operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException 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.- Parameters:
listTagsForResourceRequest
- The input parameters for theListTagsForResource
operation.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. The input parameters for theListTagsForResource
operation.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
modifyCacheCluster
default ModifyCacheClusterResponse modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
modifyCacheClusterRequest
- Represents the input of aModifyCacheCluster
operation.- Returns:
- Result of the ModifyCacheCluster operation returned by the service.
- See Also:
-
modifyCacheCluster
default ModifyCacheClusterResponse modifyCacheCluster(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest) throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyCacheClusterRequest.builder()
- Parameters:
modifyCacheClusterRequest
- AConsumer
that will call methods onModifyCacheClusterRequest.Builder
to create a request. Represents the input of aModifyCacheCluster
operation.- Returns:
- Result of the ModifyCacheCluster operation returned by the service.
- See Also:
-
modifyCacheParameterGroup
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
modifyCacheParameterGroupRequest
- Represents the input of aModifyCacheParameterGroup
operation.- Returns:
- Result of the ModifyCacheParameterGroup operation returned by the service.
- See Also:
-
modifyCacheParameterGroup
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyCacheParameterGroupRequest.builder()
- Parameters:
modifyCacheParameterGroupRequest
- AConsumer
that will call methods onModifyCacheParameterGroupRequest.Builder
to create a request. Represents the input of aModifyCacheParameterGroup
operation.- Returns:
- Result of the ModifyCacheParameterGroup operation returned by the service.
- See Also:
-
modifyCacheSubnetGroup
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException Modifies an existing cache subnet group.
- Parameters:
modifyCacheSubnetGroupRequest
- Represents the input of aModifyCacheSubnetGroup
operation.- Returns:
- Result of the ModifyCacheSubnetGroup operation returned by the service.
- See Also:
-
modifyCacheSubnetGroup
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyCacheSubnetGroupRequest.builder()
- Parameters:
modifyCacheSubnetGroupRequest
- AConsumer
that will call methods onModifyCacheSubnetGroupRequest.Builder
to create a request. Represents the input of aModifyCacheSubnetGroup
operation.- Returns:
- Result of the ModifyCacheSubnetGroup operation returned by the service.
- See Also:
-
modifyGlobalReplicationGroup
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Modifies the settings for a Global datastore.
- Parameters:
modifyGlobalReplicationGroupRequest
-- Returns:
- Result of the ModifyGlobalReplicationGroup operation returned by the service.
- See Also:
-
modifyGlobalReplicationGroup
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyGlobalReplicationGroupRequest.builder()
- Parameters:
modifyGlobalReplicationGroupRequest
- AConsumer
that will call methods onModifyGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyGlobalReplicationGroup operation returned by the service.
- See Also:
-
modifyReplicationGroup
default ModifyReplicationGroupResponse modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidUserGroupStateException, UserGroupNotFoundException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Modifies the settings for a replication group. This is limited to Redis 7 and newer.
-
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.
- Parameters:
modifyReplicationGroupRequest
- Represents the input of aModifyReplicationGroups
operation.- Returns:
- Result of the ModifyReplicationGroup operation returned by the service.
- See Also:
-
-
modifyReplicationGroup
default ModifyReplicationGroupResponse modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidUserGroupStateException, UserGroupNotFoundException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Modifies the settings for a replication group. This is limited to Redis 7 and newer.
-
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 viaModifyReplicationGroupRequest.builder()
- Parameters:
modifyReplicationGroupRequest
- AConsumer
that will call methods onModifyReplicationGroupRequest.Builder
to create a request. Represents the input of aModifyReplicationGroups
operation.- Returns:
- Result of the ModifyReplicationGroup operation returned by the service.
- See Also:
-
-
modifyReplicationGroupShardConfiguration
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
- Parameters:
modifyReplicationGroupShardConfigurationRequest
- Represents the input for aModifyReplicationGroupShardConfiguration
operation.- Returns:
- Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
- See Also:
-
modifyReplicationGroupShardConfiguration
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyReplicationGroupShardConfigurationRequest.builder()
- Parameters:
modifyReplicationGroupShardConfigurationRequest
- AConsumer
that will call methods onModifyReplicationGroupShardConfigurationRequest.Builder
to create a request. Represents the input for aModifyReplicationGroupShardConfiguration
operation.- Returns:
- Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
- See Also:
-
modifyServerlessCache
default ModifyServerlessCacheResponse modifyServerlessCache(ModifyServerlessCacheRequest modifyServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException This API modifies the attributes of a serverless cache.
- Parameters:
modifyServerlessCacheRequest
-- Returns:
- Result of the ModifyServerlessCache operation returned by the service.
- See Also:
-
modifyServerlessCache
default ModifyServerlessCacheResponse modifyServerlessCache(Consumer<ModifyServerlessCacheRequest.Builder> modifyServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException This API modifies the attributes of a serverless cache.
This is a convenience which creates an instance of the
ModifyServerlessCacheRequest.Builder
avoiding the need to create one manually viaModifyServerlessCacheRequest.builder()
- Parameters:
modifyServerlessCacheRequest
- AConsumer
that will call methods onModifyServerlessCacheRequest.Builder
to create a request.- Returns:
- Result of the ModifyServerlessCache operation returned by the service.
- See Also:
-
modifyUser
default ModifyUserResponse modifyUser(ModifyUserRequest modifyUserRequest) throws UserNotFoundException, InvalidUserStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Changes user password(s) and/or access string.
- Parameters:
modifyUserRequest
-- Returns:
- Result of the ModifyUser operation returned by the service.
- See Also:
-
modifyUser
default ModifyUserResponse modifyUser(Consumer<ModifyUserRequest.Builder> modifyUserRequest) throws UserNotFoundException, InvalidUserStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyUserRequest.builder()
- Parameters:
modifyUserRequest
- AConsumer
that will call methods onModifyUserRequest.Builder
to create a request.- Returns:
- Result of the ModifyUser operation returned by the service.
- See Also:
-
modifyUserGroup
default ModifyUserGroupResponse modifyUserGroup(ModifyUserGroupRequest modifyUserGroupRequest) throws UserGroupNotFoundException, UserNotFoundException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, InvalidUserGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Changes the list of users that belong to the user group.
- Parameters:
modifyUserGroupRequest
-- Returns:
- Result of the ModifyUserGroup operation returned by the service.
- See Also:
-
modifyUserGroup
default ModifyUserGroupResponse modifyUserGroup(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest) throws UserGroupNotFoundException, UserNotFoundException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, InvalidUserGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaModifyUserGroupRequest.builder()
- Parameters:
modifyUserGroupRequest
- AConsumer
that will call methods onModifyUserGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyUserGroup operation returned by the service.
- See Also:
-
purchaseReservedCacheNodesOffering
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
purchaseReservedCacheNodesOfferingRequest
- Represents the input of aPurchaseReservedCacheNodesOffering
operation.- Returns:
- Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
- See Also:
-
purchaseReservedCacheNodesOffering
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaPurchaseReservedCacheNodesOfferingRequest.builder()
- Parameters:
purchaseReservedCacheNodesOfferingRequest
- AConsumer
that will call methods onPurchaseReservedCacheNodesOfferingRequest.Builder
to create a request. Represents the input of aPurchaseReservedCacheNodesOffering
operation.- Returns:
- Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
- See Also:
-
rebalanceSlotsInGlobalReplicationGroup
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Redistribute slots to ensure uniform distribution across existing shards in the cluster.
- Parameters:
rebalanceSlotsInGlobalReplicationGroupRequest
-- Returns:
- Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
rebalanceSlotsInGlobalReplicationGroup
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaRebalanceSlotsInGlobalReplicationGroupRequest.builder()
- Parameters:
rebalanceSlotsInGlobalReplicationGroupRequest
- AConsumer
that will call methods onRebalanceSlotsInGlobalReplicationGroupRequest.Builder
to create a request.- Returns:
- Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
- See Also:
-
rebootCacheCluster
default RebootCacheClusterResponse rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
rebootCacheClusterRequest
- Represents the input of aRebootCacheCluster
operation.- Returns:
- Result of the RebootCacheCluster operation returned by the service.
- See Also:
-
rebootCacheCluster
default RebootCacheClusterResponse rebootCacheCluster(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest) throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaRebootCacheClusterRequest.builder()
- Parameters:
rebootCacheClusterRequest
- AConsumer
that will call methods onRebootCacheClusterRequest.Builder
to create a request. Represents the input of aRebootCacheCluster
operation.- Returns:
- Result of the RebootCacheCluster operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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.- Parameters:
removeTagsFromResourceRequest
- Represents the input of aRemoveTagsFromResource
operation.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request. Represents the input of aRemoveTagsFromResource
operation.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
resetCacheParameterGroup
default ResetCacheParameterGroupResponse resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException 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
andCacheParameterGroupName
parameters.- Parameters:
resetCacheParameterGroupRequest
- Represents the input of aResetCacheParameterGroup
operation.- Returns:
- Result of the ResetCacheParameterGroup operation returned by the service.
- See Also:
-
resetCacheParameterGroup
default ResetCacheParameterGroupResponse resetCacheParameterGroup(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException 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
andCacheParameterGroupName
parameters.
This is a convenience which creates an instance of the
ResetCacheParameterGroupRequest.Builder
avoiding the need to create one manually viaResetCacheParameterGroupRequest.builder()
- Parameters:
resetCacheParameterGroupRequest
- AConsumer
that will call methods onResetCacheParameterGroupRequest.Builder
to create a request. Represents the input of aResetCacheParameterGroup
operation.- Returns:
- Result of the ResetCacheParameterGroup operation returned by the service.
- See Also:
-
revokeCacheSecurityGroupIngress
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
- Parameters:
revokeCacheSecurityGroupIngressRequest
- Represents the input of aRevokeCacheSecurityGroupIngress
operation.- Returns:
- Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
- See Also:
-
revokeCacheSecurityGroupIngress
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaRevokeCacheSecurityGroupIngressRequest.builder()
- Parameters:
revokeCacheSecurityGroupIngressRequest
- AConsumer
that will call methods onRevokeCacheSecurityGroupIngressRequest.Builder
to create a request. Represents the input of aRevokeCacheSecurityGroupIngress
operation.- Returns:
- Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
- See Also:
-
startMigration
default StartMigrationResponse startMigration(StartMigrationRequest startMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Start the migration of data.
- Parameters:
startMigrationRequest
-- Returns:
- Result of the StartMigration operation returned by the service.
- See Also:
-
startMigration
default StartMigrationResponse startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Start the migration of data.
This is a convenience which creates an instance of the
StartMigrationRequest.Builder
avoiding the need to create one manually viaStartMigrationRequest.builder()
- Parameters:
startMigrationRequest
- AConsumer
that will call methods onStartMigrationRequest.Builder
to create a request.- Returns:
- Result of the StartMigration operation returned by the service.
- See Also:
-
testFailover
default TestFailoverResponse testFailover(TestFailoverRequest testFailoverRequest) throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException, TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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.
- Parameters:
testFailoverRequest
-- Returns:
- Result of the TestFailover operation returned by the service.
- See Also:
-
-
testFailover
default TestFailoverResponse testFailover(Consumer<TestFailoverRequest.Builder> testFailoverRequest) throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException, TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException 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 viaTestFailoverRequest.builder()
- Parameters:
testFailoverRequest
- AConsumer
that will call methods onTestFailoverRequest.Builder
to create a request.- Returns:
- Result of the TestFailover operation returned by the service.
- See Also:
-
-
testMigration
default TestMigrationResponse testMigration(TestMigrationRequest testMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Async API to test connection between source and target replication group.
- Parameters:
testMigrationRequest
-- Returns:
- Result of the TestMigration operation returned by the service.
- See Also:
-
testMigration
default TestMigrationResponse testMigration(Consumer<TestMigrationRequest.Builder> testMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException Async API to test connection between source and target replication group.
This is a convenience which creates an instance of the
TestMigrationRequest.Builder
avoiding the need to create one manually viaTestMigrationRequest.builder()
- Parameters:
testMigrationRequest
- AConsumer
that will call methods onTestMigrationRequest.Builder
to create a request.- Returns:
- Result of the TestMigration operation returned by the service.
- See Also:
-
waiter
Create an instance ofElastiCacheWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ElastiCacheWaiter
-
create
Create aElastiCacheClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aElastiCacheClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-