@Generated(value="software.amazon.awssdk:codegen") public interface ElastiCacheClient extends 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds up to 50 cost allocation tags to the named resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds up to 50 cost allocation tags to the named resource.
|
default AuthorizeCacheSecurityGroupIngressResponse |
authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)
Allows network ingress to a cache security group.
|
default AuthorizeCacheSecurityGroupIngressResponse |
authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest)
Allows network ingress to a cache security group.
|
default BatchApplyUpdateActionResponse |
batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest)
Apply the service update.
|
default BatchApplyUpdateActionResponse |
batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest)
Apply the service update.
|
default BatchStopUpdateActionResponse |
batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest)
Stop the service update.
|
default BatchStopUpdateActionResponse |
batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest)
Stop the service update.
|
static ElastiCacheClientBuilder |
builder()
Create a builder that can be used to configure and create a
ElastiCacheClient. |
default CompleteMigrationResponse |
completeMigration(CompleteMigrationRequest completeMigrationRequest)
Complete the migration of data.
|
default CompleteMigrationResponse |
completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest)
Complete the migration of data.
|
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 a
ElastiCacheClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateCacheClusterResponse |
createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest)
Creates a cluster.
|
default CreateCacheClusterResponse |
createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)
Creates a cluster.
|
default CreateCacheParameterGroupResponse |
createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest)
Creates a new Amazon ElastiCache cache parameter group.
|
default CreateCacheParameterGroupResponse |
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.
|
default CreateGlobalReplicationGroupResponse |
createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest)
Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication.
|
default CreateGlobalReplicationGroupResponse |
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 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 DecreaseNodeGroupsInGlobalReplicationGroupResponse |
decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global Datastore
|
default DecreaseNodeGroupsInGlobalReplicationGroupResponse |
decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest)
Decreases the number of node groups in a Global Datastore
|
default 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.
|
default DeleteCacheParameterGroupResponse |
deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest)
Deletes the specified cache parameter group.
|
default DeleteCacheParameterGroupResponse |
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.
|
default DeleteGlobalReplicationGroupResponse |
deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest)
Deleting a Global Datastore is a two-step process:
|
default DeleteGlobalReplicationGroupResponse |
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 DeleteSnapshotResponse |
deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)
Deletes an existing snapshot.
|
default DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)
Deletes an existing snapshot.
|
default DescribeCacheClustersResponse |
describeCacheClusters()
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default 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 |
describeCacheClustersPaginator()
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default DescribeCacheClustersIterable |
describeCacheClustersPaginator(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default DescribeCacheClustersIterable |
describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest)
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific
cache cluster if a cluster identifier is supplied.
|
default DescribeCacheEngineVersionsResponse |
describeCacheEngineVersions()
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsResponse |
describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsResponse |
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsIterable |
describeCacheEngineVersionsPaginator()
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsIterable |
describeCacheEngineVersionsPaginator(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default DescribeCacheEngineVersionsIterable |
describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)
Returns a list of the available cache engines and their versions.
|
default DescribeCacheParameterGroupsResponse |
describeCacheParameterGroups()
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsResponse |
describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsResponse |
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsIterable |
describeCacheParameterGroupsPaginator()
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsIterable |
describeCacheParameterGroupsPaginator(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
default DescribeCacheParameterGroupsIterable |
describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)
Returns a list of cache parameter group descriptions.
|
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)
Returns the detailed parameter list for a particular cache parameter group.
|
default DescribeCacheParametersIterable |
describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest)
Returns the detailed parameter list for a particular cache parameter group.
|
default DescribeCacheSecurityGroupsResponse |
describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default DescribeCacheSecurityGroupsResponse |
describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default DescribeCacheSecurityGroupsIterable |
describeCacheSecurityGroupsPaginator(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default DescribeCacheSecurityGroupsIterable |
describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)
Returns a list of cache security group descriptions.
|
default DescribeCacheSubnetGroupsResponse |
describeCacheSubnetGroups()
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsResponse |
describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsResponse |
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsIterable |
describeCacheSubnetGroupsPaginator()
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsIterable |
describeCacheSubnetGroupsPaginator(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default DescribeCacheSubnetGroupsIterable |
describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)
Returns a list of cache subnet group descriptions.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEngineDefaultParametersResponse |
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEngineDefaultParametersIterable |
describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified cache engine.
|
default DescribeEventsResponse |
describeEvents()
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 |
describeEventsPaginator()
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to clusters, cache security groups, and cache parameter groups.
|
default DescribeGlobalReplicationGroupsResponse |
describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeGlobalReplicationGroupsResponse |
describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeGlobalReplicationGroupsIterable |
describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeGlobalReplicationGroupsIterable |
describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)
Returns information about a particular global replication group.
|
default DescribeReplicationGroupsResponse |
describeReplicationGroups()
Returns information about a particular replication group.
|
default DescribeReplicationGroupsResponse |
describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default DescribeReplicationGroupsResponse |
describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default DescribeReplicationGroupsIterable |
describeReplicationGroupsPaginator()
Returns information about a particular replication group.
|
default DescribeReplicationGroupsIterable |
describeReplicationGroupsPaginator(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default DescribeReplicationGroupsIterable |
describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)
Returns information about a particular replication group.
|
default DescribeReservedCacheNodesResponse |
describeReservedCacheNodes()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesResponse |
describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesResponse |
describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesOfferingsResponse |
describeReservedCacheNodesOfferings()
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsResponse |
describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsResponse |
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsIterable |
describeReservedCacheNodesOfferingsPaginator()
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsIterable |
describeReservedCacheNodesOfferingsPaginator(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesOfferingsIterable |
describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)
Lists available reserved cache node offerings.
|
default DescribeReservedCacheNodesIterable |
describeReservedCacheNodesPaginator()
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesIterable |
describeReservedCacheNodesPaginator(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeReservedCacheNodesIterable |
describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
|
default DescribeServiceUpdatesResponse |
describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeServiceUpdatesResponse |
describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeServiceUpdatesIterable |
describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeServiceUpdatesIterable |
describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)
Returns details of the service updates
|
default DescribeSnapshotsResponse |
describeSnapshots()
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 |
describeSnapshotsPaginator()
Returns information about cluster or replication group snapshots.
|
default DescribeSnapshotsIterable |
describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default DescribeSnapshotsIterable |
describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)
Returns information about cluster or replication group snapshots.
|
default DescribeUpdateActionsResponse |
describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
|
default DescribeUpdateActionsResponse |
describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
|
default DescribeUpdateActionsIterable |
describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)
Returns details of the update actions
|
default DescribeUpdateActionsIterable |
describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest)
Returns details of the update actions
|
default DisassociateGlobalReplicationGroupResponse |
disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global Datastore using the Global Datastore name.
|
default DisassociateGlobalReplicationGroupResponse |
disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest)
Remove a secondary cluster from the Global Datastore using the Global Datastore name.
|
default FailoverGlobalReplicationGroupResponse |
failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a selected secondary region.
|
default FailoverGlobalReplicationGroupResponse |
failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest)
Used to failover the primary region to a selected secondary region.
|
default IncreaseNodeGroupsInGlobalReplicationGroupResponse |
increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global Datastore
|
default IncreaseNodeGroupsInGlobalReplicationGroupResponse |
increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest)
Increase the number of node groups in the Global Datastore
|
default IncreaseReplicaCountResponse |
increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest)
Dynamically increases the number of replics 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 replics 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 ListAllowedNodeTypeModificationsResponse |
listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest)
Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
|
default ListAllowedNodeTypeModificationsResponse |
listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)
Lists all available node types that you can scale your Redis cluster's or replication group's current node type.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all cost allocation tags currently on the named resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all cost allocation tags currently on the 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.
|
default ModifyCacheParameterGroupResponse |
modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest)
Modifies the parameters of a cache parameter group.
|
default ModifyCacheParameterGroupResponse |
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.
|
default ModifyGlobalReplicationGroupResponse |
modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest)
Modifies the settings for a Global Datastore.
|
default ModifyGlobalReplicationGroupResponse |
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.
|
default ModifyReplicationGroupShardConfigurationResponse |
modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among exisiting shards.
|
default ModifyReplicationGroupShardConfigurationResponse |
modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance
the keyspaces among exisiting shards.
|
default PurchaseReservedCacheNodesOfferingResponse |
purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
|
default PurchaseReservedCacheNodesOfferingResponse |
purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)
Allows you to purchase a reserved cache node offering.
|
default RebalanceSlotsInGlobalReplicationGroupResponse |
rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure unifirom distribution across existing shards in the cluster.
|
default RebalanceSlotsInGlobalReplicationGroupResponse |
rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest)
Redistribute slots to ensure unifirom 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 the
TagKeys list from the named resource. |
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes the tags identified by the
TagKeys 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.
|
default RevokeCacheSecurityGroupIngressResponse |
revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group.
|
default RevokeCacheSecurityGroupIngressResponse |
revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)
Revokes ingress from a cache security group.
|
static ServiceMetadata |
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 a
TestFailover operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
default TestFailoverResponse |
testFailover(TestFailoverRequest testFailoverRequest)
Represents the input of a
TestFailover operation which test automatic failover on a specified node
group (called shard in the console) in a replication group (called cluster in the console). |
serviceNameclosestatic final String SERVICE_NAME
static ElastiCacheClient create()
ElastiCacheClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElastiCacheClientBuilder builder()
ElastiCacheClient.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
addTagsToResourceRequest - Represents the input of an AddTagsToResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.
When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceMessage.Builder to create a request.
Represents the input of an AddTagsToResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
authorizeCacheSecurityGroupIngressRequest - Represents the input of an AuthorizeCacheSecurityGroupIngress operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.AuthorizationAlreadyExistsException - The specified Amazon EC2 security group is already authorized for the specified cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via AuthorizeCacheSecurityGroupIngressRequest.builder()
authorizeCacheSecurityGroupIngressRequest - A Consumer that will call methods on AuthorizeCacheSecurityGroupIngressMessage.Builder to
create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.AuthorizationAlreadyExistsException - The specified Amazon EC2 security group is already authorized for the specified cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
batchApplyUpdateActionRequest - ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via BatchApplyUpdateActionRequest.builder()
batchApplyUpdateActionRequest - A Consumer that will call methods on BatchApplyUpdateActionMessage.Builder to create a
request.ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
batchStopUpdateActionRequest - ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via BatchStopUpdateActionRequest.builder()
batchStopUpdateActionRequest - A Consumer that will call methods on BatchStopUpdateActionMessage.Builder to create a
request.ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CompleteMigrationResponse completeMigration(CompleteMigrationRequest completeMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException
Complete the migration of data.
completeMigrationRequest - ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.ReplicationGroupNotUnderMigrationException - The designated replication group is not available for data migration.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CompleteMigrationRequest.builder()
completeMigrationRequest - A Consumer that will call methods on CompleteMigrationMessage.Builder to create a request.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.ReplicationGroupNotUnderMigrationException - The designated replication group is not available for data migration.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, 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 the CopySnapshot operation. For more information about using IAM to control the
use of ElastiCache operations, see Exporting Snapshots
and Authentication & Access
Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you
could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
copySnapshotRequest - Represents the input of a CopySnapshotMessage operation.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, 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 the CopySnapshot operation. For more information about using IAM to control the
use of ElastiCache operations, see Exporting Snapshots
and Authentication & Access
Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you
could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
This is a convenience which creates an instance of the CopySnapshotRequest.Builder avoiding the need to
create one manually via CopySnapshotRequest.builder()
copySnapshotRequest - A Consumer that will call methods on CopySnapshotMessage.Builder to create a request.
Represents the input of a CopySnapshotMessage operation.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createCacheClusterRequest - Represents the input of a CreateCacheCluster operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.CacheClusterAlreadyExistsException - You already have a cluster with the given identifier.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateCacheClusterRequest.builder()
createCacheClusterRequest - A Consumer that will call methods on CreateCacheClusterMessage.Builder to create a
request. Represents the input of a CreateCacheCluster operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.CacheClusterAlreadyExistsException - You already have a cluster with the given identifier.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheParameterGroupResponse createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, 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.
createCacheParameterGroupRequest - Represents the input of a CreateCacheParameterGroup operation.CacheParameterGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum number of cache security groups.CacheParameterGroupAlreadyExistsException - A cache parameter group with the requested name already exists.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheParameterGroupResponse createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, 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 via CreateCacheParameterGroupRequest.builder()
createCacheParameterGroupRequest - A Consumer that will call methods on CreateCacheParameterGroupMessage.Builder to create a
request. Represents the input of a CreateCacheParameterGroup operation.CacheParameterGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum number of cache security groups.CacheParameterGroupAlreadyExistsException - A cache parameter group with the requested name already exists.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheSecurityGroupResponse createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, 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.
createCacheSecurityGroupRequest - Represents the input of a CreateCacheSecurityGroup operation.CacheSecurityGroupAlreadyExistsException - A cache security group with the specified name already exists.CacheSecurityGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache security groups.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheSecurityGroupResponse createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, 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 via CreateCacheSecurityGroupRequest.builder()
createCacheSecurityGroupRequest - A Consumer that will call methods on CreateCacheSecurityGroupMessage.Builder to create a
request. Represents the input of a CreateCacheSecurityGroup operation.CacheSecurityGroupAlreadyExistsException - A cache security group with the specified name already exists.CacheSecurityGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache security groups.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheSubnetGroupResponse createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, InvalidSubnetException, 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).
createCacheSubnetGroupRequest - Represents the input of a CreateCacheSubnetGroup operation.CacheSubnetGroupAlreadyExistsException - The requested cache subnet group name is already in use by an existing cache subnet group.CacheSubnetGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache subnet groups.CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
group.InvalidSubnetException - An invalid subnet identifier was specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCacheSubnetGroupResponse createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, InvalidSubnetException, 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 via CreateCacheSubnetGroupRequest.builder()
createCacheSubnetGroupRequest - A Consumer that will call methods on CreateCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a CreateCacheSubnetGroup operation.CacheSubnetGroupAlreadyExistsException - The requested cache subnet group name is already in use by an existing cache subnet group.CacheSubnetGroupQuotaExceededException - The request cannot be processed because it would exceed the allowed number of cache subnet groups.CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
group.InvalidSubnetException - An invalid subnet identifier was specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 GlobalReplicationGroupId is the name of the Global Datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
createGlobalReplicationGroupRequest - ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.GlobalReplicationGroupAlreadyExistsException - The Global Datastore name already exists.ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 GlobalReplicationGroupId is the name of the Global Datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
This is a convenience which creates an instance of the CreateGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via CreateGlobalReplicationGroupRequest.builder()
createGlobalReplicationGroupRequest - A Consumer that will call methods on CreateGlobalReplicationGroupMessage.Builder to create
a request.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.GlobalReplicationGroupAlreadyExistsException - The Global Datastore name already exists.ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateReplicationGroupResponse createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, 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 clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.
This operation is valid for Redis only.
createReplicationGroupRequest - Represents the input of a CreateReplicationGroup operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException - The requested cluster is not in the available state.ReplicationGroupAlreadyExistsException - The specified replication group already exists.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateReplicationGroupResponse createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, 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 clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.
This operation is valid for Redis only.
This is a convenience which creates an instance of the CreateReplicationGroupRequest.Builder avoiding the
need to create one manually via CreateReplicationGroupRequest.builder()
createReplicationGroupRequest - A Consumer that will call methods on CreateReplicationGroupMessage.Builder to create a
request. Represents the input of a CreateReplicationGroup operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException - The requested cluster is not in the available state.ReplicationGroupAlreadyExistsException - The specified replication group already exists.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.TagQuotaPerResourceExceededException - The request cannot be processed because it would cause the resource to have more than the allowed number
of tags. The maximum number of tags permitted on a resource is 50.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, 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.
createSnapshotRequest - Represents the input of a CreateSnapshot operation.SnapshotAlreadyExistsException - You already have a snapshot with the given name.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group is not in the available state.SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, 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 via CreateSnapshotRequest.builder()
createSnapshotRequest - A Consumer that will call methods on CreateSnapshotMessage.Builder to create a request.
Represents the input of a CreateSnapshot operation.SnapshotAlreadyExistsException - You already have a snapshot with the given name.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group is not in the available state.SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Decreases the number of node groups in a Global Datastore
decreaseNodeGroupsInGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via
DecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
decreaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on
DecreaseNodeGroupsInGlobalReplicationGroupMessage.Builder to create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
decreaseReplicaCountRequest - ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.NoOperationException - The operation was not performed because no changes were required.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DecreaseReplicaCountRequest.builder()
decreaseReplicaCountRequest - A Consumer that will call methods on DecreaseReplicaCountMessage.Builder to create a
request.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.ServiceLinkedRoleNotFoundException - The specified service linked role (SLR) was not found.NoOperationException - The operation was not performed because no changes were required.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
A cluster that is the last read replica of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
deleteCacheClusterRequest - Represents the input of a DeleteCacheCluster operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException - The requested cluster is not in the available state.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
A cluster that is the last read replica of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
This is a convenience which creates an instance of the DeleteCacheClusterRequest.Builder avoiding the
need to create one manually via DeleteCacheClusterRequest.builder()
deleteCacheClusterRequest - A Consumer that will call methods on DeleteCacheClusterMessage.Builder to create a
request. Represents the input of a DeleteCacheCluster operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException - The requested cluster is not in the available state.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteCacheParameterGroupRequest - Represents the input of a DeleteCacheParameterGroup operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DeleteCacheParameterGroupRequest.Builder avoiding
the need to create one manually via DeleteCacheParameterGroupRequest.builder()
deleteCacheParameterGroupRequest - A Consumer that will call methods on DeleteCacheParameterGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheParameterGroup operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteCacheSecurityGroupRequest - Represents the input of a DeleteCacheSecurityGroup operation.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteCacheSecurityGroupRequest.builder()
deleteCacheSecurityGroupRequest - A Consumer that will call methods on DeleteCacheSecurityGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheSecurityGroup operation.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any clusters.
deleteCacheSubnetGroupRequest - Represents the input of a DeleteCacheSubnetGroup operation.CacheSubnetGroupInUseException - The requested cache subnet group is currently in use.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache subnet group.
You cannot delete a cache subnet group if it is associated with any clusters.
This is a convenience which creates an instance of the DeleteCacheSubnetGroupRequest.Builder avoiding the
need to create one manually via DeleteCacheSubnetGroupRequest.builder()
deleteCacheSubnetGroupRequest - A Consumer that will call methods on DeleteCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a DeleteCacheSubnetGroup operation.CacheSubnetGroupInUseException - The requested cache subnet group is currently in use.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore 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.
deleteGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore 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 DeleteGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via DeleteGlobalReplicationGroupRequest.builder()
deleteGlobalReplicationGroupRequest - A Consumer that will call methods on DeleteGlobalReplicationGroupMessage.Builder to create
a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteReplicationGroupRequest - Represents the input of a DeleteReplicationGroup operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteReplicationGroupRequest.builder()
deleteReplicationGroupRequest - A Consumer that will call methods on DeleteReplicationGroupMessage.Builder to create a
request. Represents the input of a DeleteReplicationGroup operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.SnapshotAlreadyExistsException - You already have a snapshot with the given name.SnapshotFeatureNotSupportedException - You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException - The request cannot be processed because it would exceed the maximum number of snapshots.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteSnapshotRequest - Represents the input of a DeleteSnapshot operation.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteSnapshotRequest.builder()
deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotMessage.Builder to create a request.
Represents the input of a DeleteSnapshot operation.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidSnapshotStateException - The current state of the snapshot does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheClustersResponse describeCacheClusters() 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.
CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheClusters(DescribeCacheClustersRequest),
AWS API Documentationdefault 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.
describeCacheClustersRequest - Represents the input of a DescribeCacheClusters operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheClustersRequest.builder()
describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersMessage.Builder to create a
request. Represents the input of a DescribeCacheClusters operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheClustersIterable describeCacheClustersPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheClustersPaginator(DescribeCacheClustersRequest),
AWS API Documentationdefault DescribeCacheClustersIterable describeCacheClustersPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
describeCacheClustersRequest - Represents the input of a DescribeCacheClusters operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheClustersIterable describeCacheClustersPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheClustersRequest.Builder avoiding the
need to create one manually via DescribeCacheClustersRequest.builder()
describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersMessage.Builder to create a
request. Represents the input of a DescribeCacheClusters operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheEngineVersionsResponse describeCacheEngineVersions() throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest),
AWS API Documentationdefault DescribeCacheEngineVersionsResponse describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheEngineVersionsRequest.builder()
describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsMessage.Builder to create
a request. Represents the input of a DescribeCacheEngineVersions operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator() throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest),
AWS API Documentationdefault DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheEngineVersionsRequest.Builder
avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()
describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsMessage.Builder to create
a request. Represents the input of a DescribeCacheEngineVersions operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParameterGroupsResponse describeCacheParameterGroups() 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.
CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest),
AWS API Documentationdefault 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.
describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheParameterGroupsRequest.builder()
describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheParameterGroups operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest),
AWS API Documentationdefault DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()
describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheParameterGroups operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParametersResponse describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the detailed parameter list for a particular cache parameter group.
describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheParametersRequest.builder()
describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersMessage.Builder to create a
request. Represents the input of a DescribeCacheParameters operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParametersIterable describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the detailed parameter list for a particular cache parameter group.
This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.
describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheParametersIterable describeCacheParametersPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheParametersRequest.Builder avoiding
the need to create one manually via DescribeCacheParametersRequest.builder()
describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersMessage.Builder to create a
request. Represents the input of a DescribeCacheParameters operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheSecurityGroupsRequest.builder()
describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheSecurityGroups operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(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
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.
describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheSecurityGroupsRequest.Builder
avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()
describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsMessage.Builder to create
a request. Represents the input of a DescribeCacheSecurityGroups operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups() 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.
CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest),
AWS API Documentationdefault 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.
describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeCacheSubnetGroupsRequest.builder()
describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsMessage.Builder to create a
request. Represents the input of a DescribeCacheSubnetGroups operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest),
AWS API Documentationdefault DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeCacheSubnetGroupsRequest.Builder avoiding
the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()
describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsMessage.Builder to create a
request. Represents the input of a DescribeCacheSubnetGroups operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the default engine and system parameter information for the specified cache engine.
describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersMessage.Builder to
create a request. Represents the input of a DescribeEngineDefaultParameters operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the default engine and system parameter information for the specified cache engine.
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.
describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()
describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersMessage.Builder to
create a request. Represents the input of a DescribeEngineDefaultParameters operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents() 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.
InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEvents(DescribeEventsRequest),
AWS API
Documentationdefault 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.
describeEventsRequest - Represents the input of a DescribeEvents operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input of a DescribeEvents operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsIterable describeEventsPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.
InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventsPaginator(DescribeEventsRequest),
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.
describeEventsRequest - Represents the input of a DescribeEvents operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsIterable describeEventsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input of a DescribeEvents operation.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeGlobalReplicationGroupsRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeGlobalReplicationGroupsRequest.builder()
describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsMessage.Builder to
create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.
describeGlobalReplicationGroupsRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeGlobalReplicationGroupsRequest.Builder
avoiding the need to create one manually via DescribeGlobalReplicationGroupsRequest.builder()
describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsMessage.Builder to
create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReplicationGroupsResponse describeReplicationGroups() 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.
ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReplicationGroups(DescribeReplicationGroupsRequest),
AWS API Documentationdefault 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.
describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeReplicationGroupsRequest.builder()
describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsMessage.Builder to create a
request. Represents the input of a DescribeReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReplicationGroupsIterable describeReplicationGroupsPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReplicationGroupsPaginator(DescribeReplicationGroupsRequest),
AWS API Documentationdefault DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeReplicationGroupsRequest.Builder avoiding
the need to create one manually via DescribeReplicationGroupsRequest.builder()
describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsMessage.Builder to create a
request. Represents the input of a DescribeReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesResponse describeReservedCacheNodes() throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedCacheNodes(DescribeReservedCacheNodesRequest),
AWS API Documentationdefault 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.
describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeReservedCacheNodesRequest.builder()
describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesMessage.Builder to create a
request. Represents the input of a DescribeReservedCacheNodes operation.ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest),
AWS API Documentationdefault DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedCacheNodesRequest.Builder avoiding
the need to create one manually via DescribeReservedCacheNodesRequest.builder()
describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesMessage.Builder to create a
request. Represents the input of a DescribeReservedCacheNodes operation.ReservedCacheNodeNotFoundException - The requested reserved cache node was not found.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest),
AWS API Documentationdefault DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeReservedCacheNodesOfferingsRequest.builder()
describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsMessage.Builder to
create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest),
AWS API Documentationdefault DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)
operation.
This is a convenience which creates an instance of the DescribeReservedCacheNodesOfferingsRequest.Builder
avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()
describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsMessage.Builder to
create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServiceUpdatesResponse describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the service updates
describeServiceUpdatesRequest - ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeServiceUpdatesRequest.builder()
describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesMessage.Builder to create a
request.ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the service updates
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.
describeServiceUpdatesRequest - ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the service updates
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)
operation.
This is a convenience which creates an instance of the DescribeServiceUpdatesRequest.Builder avoiding the
need to create one manually via DescribeServiceUpdatesRequest.builder()
describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesMessage.Builder to create a
request.ServiceUpdateNotFoundException - The service update doesn't existInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsResponse describeSnapshots() 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.
CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeSnapshots(DescribeSnapshotsRequest),
AWS
API Documentationdefault 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.
describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsMessage.Builder to create a request.
Represents the input of a DescribeSnapshotsMessage operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsIterable describeSnapshotsPaginator() 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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeSnapshotsPaginator(DescribeSnapshotsRequest),
AWS
API Documentationdefault DescribeSnapshotsIterable describeSnapshotsPaginator(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.
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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSnapshotsIterable describeSnapshotsPaginator(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 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)
operation.
This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need
to create one manually via DescribeSnapshotsRequest.builder()
describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsMessage.Builder to create a request.
Represents the input of a DescribeSnapshotsMessage operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUpdateActionsResponse describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the update actions
describeUpdateActionsRequest - InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeUpdateActionsRequest.builder()
describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsMessage.Builder to create a
request.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUpdateActionsIterable describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the update actions
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.
describeUpdateActionsRequest - InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeUpdateActionsIterable describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the update actions
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation. The return type is a custom 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 Stream
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)
operation.
This is a convenience which creates an instance of the DescribeUpdateActionsRequest.Builder avoiding the
need to create one manually via DescribeUpdateActionsRequest.builder()
describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsMessage.Builder to create a
request.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS region.
disassociateGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AWS region.
This is a convenience which creates an instance of the DisassociateGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via DisassociateGlobalReplicationGroupRequest.builder()
disassociateGlobalReplicationGroupRequest - A Consumer that will call methods on DisassociateGlobalReplicationGroupMessage.Builder to
create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Used to failover the primary region to a selected secondary region.
failoverGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Used to failover the primary region to a selected secondary region.
This is a convenience which creates an instance of the FailoverGlobalReplicationGroupRequest.Builder
avoiding the need to create one manually via FailoverGlobalReplicationGroupRequest.builder()
failoverGlobalReplicationGroupRequest - A Consumer that will call methods on FailoverGlobalReplicationGroupMessage.Builder to
create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Increase the number of node groups in the Global Datastore
increaseNodeGroupsInGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via
IncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()
increaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on
IncreaseNodeGroupsInGlobalReplicationGroupMessage.Builder to create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
increaseReplicaCountRequest - ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.NoOperationException - The operation was not performed because no changes were required.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
This is a convenience which creates an instance of the IncreaseReplicaCountRequest.Builder avoiding the
need to create one manually via IncreaseReplicaCountRequest.builder()
increaseReplicaCountRequest - A Consumer that will call methods on IncreaseReplicaCountMessage.Builder to create a
request.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.NoOperationException - The operation was not performed because no changes were required.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or ModifyReplicationGroup operations to scale your
cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
returned by this operation.
listAllowedNodeTypeModificationsRequest - The input parameters for the ListAllowedNodeTypeModifications operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or ModifyReplicationGroup operations to scale your
cluster or replication group, the value of the CacheNodeType parameter must be one of the node types
returned by this operation.
This is a convenience which creates an instance of the ListAllowedNodeTypeModificationsRequest.Builder
avoiding the need to create one manually via ListAllowedNodeTypeModificationsRequest.builder()
listAllowedNodeTypeModificationsRequest - A Consumer that will call methods on ListAllowedNodeTypeModificationsMessage.Builder to
create a request. The input parameters for the ListAllowedNodeTypeModifications operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value
pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize
and track your AWS costs.
If the cluster is not in the available state, ListTagsForResource returns an error.
You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
listTagsForResourceRequest - The input parameters for the ListTagsForResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value
pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize
and track your AWS costs.
If the cluster is not in the available state, ListTagsForResource returns an error.
You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceMessage.Builder to create a
request. The input parameters for the ListTagsForResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
modifyCacheClusterRequest - Represents the input of a ModifyCacheCluster operation.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ModifyCacheClusterRequest.builder()
modifyCacheClusterRequest - A Consumer that will call methods on ModifyCacheClusterMessage.Builder to create a
request. Represents the input of a ModifyCacheCluster operation.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
modifyCacheParameterGroupRequest - Represents the input of a ModifyCacheParameterGroup operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidGlobalReplicationGroupStateException - The Global Datastore is not availableSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ModifyCacheParameterGroupRequest.builder()
modifyCacheParameterGroupRequest - A Consumer that will call methods on ModifyCacheParameterGroupMessage.Builder to create a
request. Represents the input of a ModifyCacheParameterGroup operation.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidGlobalReplicationGroupStateException - The Global Datastore is not availableSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies an existing cache subnet group.
modifyCacheSubnetGroupRequest - Represents the input of a ModifyCacheSubnetGroup operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
group.SubnetInUseException - The requested subnet is being used by another cache subnet group.InvalidSubnetException - An invalid subnet identifier was specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, 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 via ModifyCacheSubnetGroupRequest.builder()
modifyCacheSubnetGroupRequest - A Consumer that will call methods on ModifyCacheSubnetGroupMessage.Builder to create a
request. Represents the input of a ModifyCacheSubnetGroup operation.CacheSubnetGroupNotFoundException - The requested cache subnet group name does not refer to an existing cache subnet group.CacheSubnetQuotaExceededException - The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet
group.SubnetInUseException - The requested subnet is being used by another cache subnet group.InvalidSubnetException - An invalid subnet identifier was specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a Global Datastore.
modifyGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ModifyGlobalReplicationGroupRequest.builder()
modifyGlobalReplicationGroupRequest - A Consumer that will call methods on ModifyGlobalReplicationGroupMessage.Builder to create
a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyReplicationGroupResponse modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a replication group.
For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.
modifyReplicationGroupRequest - Represents the input of a ModifyReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyReplicationGroupResponse modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a replication group.
For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.
This is a convenience which creates an instance of the ModifyReplicationGroupRequest.Builder avoiding the
need to create one manually via ModifyReplicationGroupRequest.builder()
modifyReplicationGroupRequest - A Consumer that will call methods on ModifyReplicationGroupMessage.Builder to create a
request. Represents the input of a ModifyReplicationGroups operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.NodeQuotaForClusterExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes in a single
cluster.NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 exisiting shards.
modifyReplicationGroupShardConfigurationRequest - Represents the input for a ModifyReplicationGroupShardConfiguration operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 exisiting shards.
This is a convenience which creates an instance of the
ModifyReplicationGroupShardConfigurationRequest.Builder avoiding the need to create one manually via
ModifyReplicationGroupShardConfigurationRequest.builder()
modifyReplicationGroupShardConfigurationRequest - A Consumer that will call methods on
ModifyReplicationGroupShardConfigurationMessage.Builder to create a request. Represents the input
for a ModifyReplicationGroupShardConfiguration operation.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidVpcNetworkStateException - The VPC network is in an invalid state.InsufficientCacheClusterCapacityException - The requested cache node type is not available in the specified Availability Zone. For more information,
see InsufficientCacheClusterCapacity in the ElastiCache User Guide.NodeGroupsPerReplicationGroupQuotaExceededException - The request cannot be processed because it would exceed the maximum allowed number of node groups
(shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException - The request cannot be processed because it would exceed the allowed number of cache nodes per customer.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows you to purchase a reserved cache node offering.
purchaseReservedCacheNodesOfferingRequest - Represents the input of a PurchaseReservedCacheNodesOffering operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.ReservedCacheNodeAlreadyExistsException - You already have a reservation with the given identifier.ReservedCacheNodeQuotaExceededException - The request cannot be processed because it would exceed the user's cache node quota.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows you to purchase a reserved cache node offering.
This is a convenience which creates an instance of the PurchaseReservedCacheNodesOfferingRequest.Builder
avoiding the need to create one manually via PurchaseReservedCacheNodesOfferingRequest.builder()
purchaseReservedCacheNodesOfferingRequest - A Consumer that will call methods on PurchaseReservedCacheNodesOfferingMessage.Builder to
create a request. Represents the input of a PurchaseReservedCacheNodesOffering operation.ReservedCacheNodesOfferingNotFoundException - The requested cache node offering does not exist.ReservedCacheNodeAlreadyExistsException - You already have a reservation with the given identifier.ReservedCacheNodeQuotaExceededException - The request cannot be processed because it would exceed the user's cache node quota.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Redistribute slots to ensure unifirom distribution across existing shards in the cluster.
rebalanceSlotsInGlobalReplicationGroupRequest - GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Redistribute slots to ensure unifirom distribution across existing shards in the cluster.
This is a convenience which creates an instance of the
RebalanceSlotsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via
RebalanceSlotsInGlobalReplicationGroupRequest.builder()
rebalanceSlotsInGlobalReplicationGroupRequest - A Consumer that will call methods on RebalanceSlotsInGlobalReplicationGroupMessage.Builder
to create a request.GlobalReplicationGroupNotFoundException - The Global Datastore does not existInvalidGlobalReplicationGroupStateException - The Global Datastore is not availableInvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
rebootCacheClusterRequest - Represents the input of a RebootCacheCluster operation.InvalidCacheClusterStateException - The requested cluster is not in the available state.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RebootCacheClusterRequest.builder()
rebootCacheClusterRequest - A Consumer that will call methods on RebootCacheClusterMessage.Builder to create a
request. Represents the input of a RebootCacheCluster operation.InvalidCacheClusterStateException - The requested cluster is not in the available state.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Removes the tags identified by the TagKeys list from the named resource.
removeTagsFromResourceRequest - Represents the input of a RemoveTagsFromResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.TagNotFoundException - The requested tag was not found on this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Removes the tags identified by the TagKeys list from the named resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceMessage.Builder to create a
request. Represents the input of a RemoveTagsFromResource operation.CacheClusterNotFoundException - The requested cluster ID does not refer to an existing cluster.SnapshotNotFoundException - The requested snapshot name does not refer to an existing snapshot.InvalidArnException - The requested Amazon Resource Name (ARN) does not refer to an existing resource.TagNotFoundException - The requested tag was not found on this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 and CacheParameterGroupName parameters.
resetCacheParameterGroupRequest - Represents the input of a ResetCacheParameterGroup operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidGlobalReplicationGroupStateException - The Global Datastore is not availableSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 and CacheParameterGroupName parameters.
This is a convenience which creates an instance of the ResetCacheParameterGroupRequest.Builder avoiding
the need to create one manually via ResetCacheParameterGroupRequest.builder()
resetCacheParameterGroupRequest - A Consumer that will call methods on ResetCacheParameterGroupMessage.Builder to create a
request. Represents the input of a ResetCacheParameterGroup operation.InvalidCacheParameterGroupStateException - The current state of the cache parameter group does not allow the requested operation to occur.CacheParameterGroupNotFoundException - The requested cache parameter group name does not refer to an existing cache parameter group.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.InvalidGlobalReplicationGroupStateException - The Global Datastore is not availableSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
revokeCacheSecurityGroupIngressRequest - Represents the input of a RevokeCacheSecurityGroupIngress operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.AuthorizationNotFoundException - The specified Amazon EC2 security group is not authorized for the specified cache security group.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RevokeCacheSecurityGroupIngressRequest.builder()
revokeCacheSecurityGroupIngressRequest - A Consumer that will call methods on RevokeCacheSecurityGroupIngressMessage.Builder to
create a request. Represents the input of a RevokeCacheSecurityGroupIngress operation.CacheSecurityGroupNotFoundException - The requested cache security group name does not refer to an existing cache security group.AuthorizationNotFoundException - The specified Amazon EC2 security group is not authorized for the specified cache security group.InvalidCacheSecurityGroupStateException - The current state of the cache security group does not allow deletion.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartMigrationResponse startMigration(StartMigrationRequest startMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Start the migration of data.
startMigrationRequest - ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.ReplicationGroupAlreadyUnderMigrationException - The targeted replication group is not available.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartMigrationRequest.builder()
startMigrationRequest - A Consumer that will call methods on StartMigrationMessage.Builder to create a request.ReplicationGroupNotFoundException - The specified replication group does not exist.InvalidReplicationGroupStateException - The requested replication group is not in the available state.ReplicationGroupAlreadyUnderMigrationException - The targeted replication group is not available.InvalidParameterValueException - The value for a parameter is invalid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
testFailoverRequest - ApiCallRateForCustomerExceededException - The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group is not in the available state.NodeGroupNotFoundException - The node group specified by the NodeGroupId parameter could not be found. Please verify that
the node group exists and that you spelled the NodeGroupId value correctly.ReplicationGroupNotFoundException - The specified replication group does not exist.TestFailoverNotAvailableException - The TestFailover action is not available.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Replication group message:
Failover from master node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
This is a convenience which creates an instance of the TestFailoverRequest.Builder avoiding the need to
create one manually via TestFailoverRequest.builder()
testFailoverRequest - A Consumer that will call methods on TestFailoverMessage.Builder to create a request.ApiCallRateForCustomerExceededException - The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException - The requested cluster is not in the available state.InvalidReplicationGroupStateException - The requested replication group is not in the available state.NodeGroupNotFoundException - The node group specified by the NodeGroupId parameter could not be found. Please verify that
the node group exists and that you spelled the NodeGroupId value correctly.ReplicationGroupNotFoundException - The specified replication group does not exist.TestFailoverNotAvailableException - The TestFailover action is not available.InvalidKmsKeyException - The KMS key supplied is not valid.InvalidParameterValueException - The value for a parameter is invalid.InvalidParameterCombinationException - Two or more incompatible parameters were specified.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.