Interface ElastiCacheAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ElastiCacheAsyncClient extends AwsClient
Service client for accessing Amazon ElastiCache asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

  • Field Details

  • Method Details

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

      A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.

      For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

      For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

      Parameters:
      addTagsToResourceRequest - Represents the input of an AddTagsToResource operation.
      Returns:
      A Java Future containing the result of the AddTagsToResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • addTagsToResource

      default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)

      A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.

      For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

      For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.


      This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need to create one manually via AddTagsToResourceRequest.builder()

      Parameters:
      addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request. Represents the input of an AddTagsToResource operation.
      Returns:
      A Java Future containing the result of the AddTagsToResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • authorizeCacheSecurityGroupIngress

      default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest)

      Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

      You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

      Parameters:
      authorizeCacheSecurityGroupIngressRequest - Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
      Returns:
      A Java Future containing the result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • authorizeCacheSecurityGroupIngress

      default CompletableFuture<AuthorizeCacheSecurityGroupIngressResponse> authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest)

      Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

      You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.


      This is a convenience which creates an instance of the AuthorizeCacheSecurityGroupIngressRequest.Builder avoiding the need to create one manually via AuthorizeCacheSecurityGroupIngressRequest.builder()

      Parameters:
      authorizeCacheSecurityGroupIngressRequest - A Consumer that will call methods on AuthorizeCacheSecurityGroupIngressRequest.Builder to create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
      Returns:
      A Java Future containing the result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchApplyUpdateAction

      default CompletableFuture<BatchApplyUpdateActionResponse> batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest)

      Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

      Parameters:
      batchApplyUpdateActionRequest -
      Returns:
      A Java Future containing the result of the BatchApplyUpdateAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't exist
      • 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.
      See Also:

    • batchApplyUpdateAction

      default CompletableFuture<BatchApplyUpdateActionResponse> batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest)

      Apply the service update. For more information on service updates and applying them, see Applying Service Updates.


      This is a convenience which creates an instance of the BatchApplyUpdateActionRequest.Builder avoiding the need to create one manually via BatchApplyUpdateActionRequest.builder()

      Parameters:
      batchApplyUpdateActionRequest - A Consumer that will call methods on BatchApplyUpdateActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchApplyUpdateAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't exist
      • 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.
      See Also:

    • batchStopUpdateAction

      default CompletableFuture<BatchStopUpdateActionResponse> batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest)

      Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

      Parameters:
      batchStopUpdateActionRequest -
      Returns:
      A Java Future containing the result of the BatchStopUpdateAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't exist
      • 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.
      See Also:

    • batchStopUpdateAction

      default CompletableFuture<BatchStopUpdateActionResponse> batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest)

      Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.


      This is a convenience which creates an instance of the BatchStopUpdateActionRequest.Builder avoiding the need to create one manually via BatchStopUpdateActionRequest.builder()

      Parameters:
      batchStopUpdateActionRequest - A Consumer that will call methods on BatchStopUpdateActionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchStopUpdateAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't exist
      • 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.
      See Also:

    • completeMigration

      default CompletableFuture<CompleteMigrationResponse> completeMigration(CompleteMigrationRequest completeMigrationRequest)

      Complete the migration of data.

      Parameters:
      completeMigrationRequest -
      Returns:
      A Java Future containing the result of the CompleteMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • completeMigration

      default CompletableFuture<CompleteMigrationResponse> completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest)

      Complete the migration of data.


      This is a convenience which creates an instance of the CompleteMigrationRequest.Builder avoiding the need to create one manually via CompleteMigrationRequest.builder()

      Parameters:
      completeMigrationRequest - A Consumer that will call methods on CompleteMigrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CompleteMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • copyServerlessCacheSnapshot

      default CompletableFuture<CopyServerlessCacheSnapshotResponse> copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest)

      Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

      Parameters:
      copyServerlessCacheSnapshotRequest -
      Returns:
      A Java Future containing the result of the CopyServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheSnapshotQuotaExceededException The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • copyServerlessCacheSnapshot

      default CompletableFuture<CopyServerlessCacheSnapshotResponse> copyServerlessCacheSnapshot(Consumer<CopyServerlessCacheSnapshotRequest.Builder> copyServerlessCacheSnapshotRequest)

      Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.


      This is a convenience which creates an instance of the CopyServerlessCacheSnapshotRequest.Builder avoiding the need to create one manually via CopyServerlessCacheSnapshotRequest.builder()

      Parameters:
      copyServerlessCacheSnapshotRequest - A Consumer that will call methods on CopyServerlessCacheSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheSnapshotQuotaExceededException The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • copySnapshot

      default CompletableFuture<CopySnapshotResponse> copySnapshot(CopySnapshotRequest copySnapshotRequest)

      Makes a copy of an existing snapshot.

      This operation is valid for Valkey or Redis OSS only.

      Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

      You could receive the following error messages.

      Error Messages

      • Error Message: The S3 bucket %s is outside of the region.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The S3 bucket %s does not exist.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The S3 bucket %s is not owned by the authenticated user.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

        Solution: Contact your system administrator to get the needed permissions.

      • Error Message: The S3 bucket %s already contains an object with key %s.

        Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

      • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

        Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

        Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

        Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

      Parameters:
      copySnapshotRequest - Represents the input of a CopySnapshotMessage operation.
      Returns:
      A Java Future containing the result of the CopySnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • copySnapshot

      default CompletableFuture<CopySnapshotResponse> copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)

      Makes a copy of an existing snapshot.

      This operation is valid for Valkey or Redis OSS only.

      Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

      You could receive the following error messages.

      Error Messages

      • Error Message: The S3 bucket %s is outside of the region.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The S3 bucket %s does not exist.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The S3 bucket %s is not owned by the authenticated user.

        Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

        Solution: Contact your system administrator to get the needed permissions.

      • Error Message: The S3 bucket %s already contains an object with key %s.

        Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

      • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

        Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

        Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

      • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

        Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.


      This is a convenience which creates an instance of the CopySnapshotRequest.Builder avoiding the need to create one manually via CopySnapshotRequest.builder()

      Parameters:
      copySnapshotRequest - A Consumer that will call methods on CopySnapshotRequest.Builder to create a request. Represents the input of a CopySnapshotMessage operation.
      Returns:
      A Java Future containing the result of the CopySnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • createCacheCluster

      default CompletableFuture<CreateCacheClusterResponse> createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest)

      Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.

      This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

      Parameters:
      createCacheClusterRequest - Represents the input of a CreateCacheCluster operation.
      Returns:
      A Java Future containing the result of the CreateCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCacheCluster

      default CompletableFuture<CreateCacheClusterResponse> createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest)

      Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.

      This operation is not supported for Valkey or Redis OSS (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()

      Parameters:
      createCacheClusterRequest - A Consumer that will call methods on CreateCacheClusterRequest.Builder to create a request. Represents the input of a CreateCacheCluster operation.
      Returns:
      A Java Future containing the result of the CreateCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCacheParameterGroup

      default CompletableFuture<CreateCacheParameterGroupResponse> createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest)

      Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

      A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

      Parameters:
      createCacheParameterGroupRequest - Represents the input of a CreateCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • createCacheParameterGroup

      default CompletableFuture<CreateCacheParameterGroupResponse> createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest)

      Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

      A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:


      This is a convenience which creates an instance of the CreateCacheParameterGroupRequest.Builder avoiding the need to create one manually via CreateCacheParameterGroupRequest.builder()

      Parameters:
      createCacheParameterGroupRequest - A Consumer that will call methods on CreateCacheParameterGroupRequest.Builder to create a request. Represents the input of a CreateCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • createCacheSecurityGroup

      default CompletableFuture<CreateCacheSecurityGroupResponse> createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest)

      Creates a new cache security group. Use a cache security group to control access to one or more clusters.

      Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

      Parameters:
      createCacheSecurityGroupRequest - Represents the input of a CreateCacheSecurityGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheSecurityGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • createCacheSecurityGroup

      default CompletableFuture<CreateCacheSecurityGroupResponse> createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest)

      Creates a new cache security group. Use a cache security group to control access to one or more clusters.

      Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.


      This is a convenience which creates an instance of the CreateCacheSecurityGroupRequest.Builder avoiding the need to create one manually via CreateCacheSecurityGroupRequest.builder()

      Parameters:
      createCacheSecurityGroupRequest - A Consumer that will call methods on CreateCacheSecurityGroupRequest.Builder to create a request. Represents the input of a CreateCacheSecurityGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheSecurityGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • createCacheSubnetGroup

      default CompletableFuture<CreateCacheSubnetGroupResponse> createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest)

      Creates a new cache subnet group.

      Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

      Parameters:
      createCacheSubnetGroupRequest - Represents the input of a CreateCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • InvalidSubnetException An invalid subnet identifier was specified.
      • SubnetNotAllowedException At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
      • 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.
      See Also:

    • createCacheSubnetGroup

      default CompletableFuture<CreateCacheSubnetGroupResponse> createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest)

      Creates a new cache subnet group.

      Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).


      This is a convenience which creates an instance of the CreateCacheSubnetGroupRequest.Builder avoiding the need to create one manually via CreateCacheSubnetGroupRequest.builder()

      Parameters:
      createCacheSubnetGroupRequest - A Consumer that will call methods on CreateCacheSubnetGroupRequest.Builder to create a request. Represents the input of a CreateCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the CreateCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • InvalidSubnetException An invalid subnet identifier was specified.
      • SubnetNotAllowedException At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
      • 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.
      See Also:

    • createGlobalReplicationGroup

      default CompletableFuture<CreateGlobalReplicationGroupResponse> createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest)

      Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.

      • The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

      • The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

      Parameters:
      createGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the CreateGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createGlobalReplicationGroup

      default CompletableFuture<CreateGlobalReplicationGroupResponse> createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest)

      Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.

      • The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

      • The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.


      This is a convenience which creates an instance of the CreateGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via CreateGlobalReplicationGroupRequest.builder()

      Parameters:
      createGlobalReplicationGroupRequest - A Consumer that will call methods on CreateGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createReplicationGroup

      default CompletableFuture<CreateReplicationGroupResponse> createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest)

      Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.

      This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

      A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

      A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

      The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

      To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

      When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide.

      This operation is valid for Valkey and Redis OSS only.

      Parameters:
      createReplicationGroupRequest - Represents the input of a CreateReplicationGroup operation.
      Returns:
      A Java Future containing the result of the CreateReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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 90
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • createReplicationGroup

      default CompletableFuture<CreateReplicationGroupResponse> createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest)

      Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.

      This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

      A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

      A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

      The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

      To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

      When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide.

      This operation is valid for Valkey and Redis OSS only.


      This is a convenience which creates an instance of the CreateReplicationGroupRequest.Builder avoiding the need to create one manually via CreateReplicationGroupRequest.builder()

      Parameters:
      createReplicationGroupRequest - A Consumer that will call methods on CreateReplicationGroupRequest.Builder to create a request. Represents the input of a CreateReplicationGroup operation.
      Returns:
      A Java Future containing the result of the CreateReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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 90
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • createServerlessCache

      default CompletableFuture<CreateServerlessCacheResponse> createServerlessCache(CreateServerlessCacheRequest createServerlessCacheRequest)

      Creates a serverless cache.

      Parameters:
      createServerlessCacheRequest -
      Returns:
      A Java Future containing the result of the CreateServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheAlreadyExistsException A serverless cache with this name already exists.
      • ServerlessCacheQuotaForCustomerExceededException The number of serverless caches exceeds the customer quota.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • createServerlessCache

      default CompletableFuture<CreateServerlessCacheResponse> createServerlessCache(Consumer<CreateServerlessCacheRequest.Builder> createServerlessCacheRequest)

      Creates a serverless cache.


      This is a convenience which creates an instance of the CreateServerlessCacheRequest.Builder avoiding the need to create one manually via CreateServerlessCacheRequest.builder()

      Parameters:
      createServerlessCacheRequest - A Consumer that will call methods on CreateServerlessCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheAlreadyExistsException A serverless cache with this name already exists.
      • ServerlessCacheQuotaForCustomerExceededException The number of serverless caches exceeds the customer quota.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • createServerlessCacheSnapshot

      default CompletableFuture<CreateServerlessCacheSnapshotResponse> createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest)

      This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

      Parameters:
      createServerlessCacheSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotQuotaExceededException The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • createServerlessCacheSnapshot

      default CompletableFuture<CreateServerlessCacheSnapshotResponse> createServerlessCacheSnapshot(Consumer<CreateServerlessCacheSnapshotRequest.Builder> createServerlessCacheSnapshotRequest)

      This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.


      This is a convenience which creates an instance of the CreateServerlessCacheSnapshotRequest.Builder avoiding the need to create one manually via CreateServerlessCacheSnapshotRequest.builder()

      Parameters:
      createServerlessCacheSnapshotRequest - A Consumer that will call methods on CreateServerlessCacheSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotQuotaExceededException The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest)

      Creates a copy of an entire cluster or replication group at a specific moment in time.

      This operation is valid for Valkey or Redis OSS only.

      Parameters:
      createSnapshotRequest - Represents the input of a CreateSnapshot operation.
      Returns:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        Neither of these are supported by ElastiCache.

      • 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.
      • 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.
      See Also:

    • createSnapshot

      default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest)

      Creates a copy of an entire cluster or replication group at a specific moment in time.

      This operation is valid for Valkey or Redis OSS only.


      This is a convenience which creates an instance of the CreateSnapshotRequest.Builder avoiding the need to create one manually via CreateSnapshotRequest.builder()

      Parameters:
      createSnapshotRequest - A Consumer that will call methods on CreateSnapshotRequest.Builder to create a request. Represents the input of a CreateSnapshot operation.
      Returns:
      A Java Future containing the result of the CreateSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        Neither of these are supported by ElastiCache.

      • 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.
      • 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.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see Using Role Based Access Control (RBAC).

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserAlreadyExistsException A user with this ID already exists.
      • UserQuotaExceededException The quota of users has been exceeded.
      • DuplicateUserNameException A user with this username already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • 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.
      • 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.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see Using Role Based Access Control (RBAC).


      This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to create one manually via CreateUserRequest.builder()

      Parameters:
      createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserAlreadyExistsException A user with this ID already exists.
      • UserQuotaExceededException The quota of users has been exceeded.
      • DuplicateUserNameException A user with this username already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • 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.
      • 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.
      See Also:

    • createUserGroup

      default CompletableFuture<CreateUserGroupResponse> createUserGroup(CreateUserGroupRequest createUserGroupRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC)

      Parameters:
      createUserGroupRequest -
      Returns:
      A Java Future containing the result of the CreateUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • DuplicateUserNameException A user with this username already exists.
      • UserGroupAlreadyExistsException The user group with this ID already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • DefaultUserRequiredException You must add default user to a user group.
      • UserGroupQuotaExceededException The number of users exceeds the user group limit.
      • InvalidParameterValueException The value for a parameter is invalid.
      • 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.
      • 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.
      See Also:

    • createUserGroup

      default CompletableFuture<CreateUserGroupResponse> createUserGroup(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC)


      This is a convenience which creates an instance of the CreateUserGroupRequest.Builder avoiding the need to create one manually via CreateUserGroupRequest.builder()

      Parameters:
      createUserGroupRequest - A Consumer that will call methods on CreateUserGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • DuplicateUserNameException A user with this username already exists.
      • UserGroupAlreadyExistsException The user group with this ID already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • DefaultUserRequiredException You must add default user to a user group.
      • UserGroupQuotaExceededException The number of users exceeds the user group limit.
      • InvalidParameterValueException The value for a parameter is invalid.
      • 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.
      • 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.
      See Also:

    • decreaseNodeGroupsInGlobalReplicationGroup

      default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest)

      Decreases the number of node groups in a Global datastore

      Parameters:
      decreaseNodeGroupsInGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • decreaseNodeGroupsInGlobalReplicationGroup

      default CompletableFuture<DecreaseNodeGroupsInGlobalReplicationGroupResponse> decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest)

      Decreases the number of node groups in a Global datastore


      This is a convenience which creates an instance of the DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via DecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()

      Parameters:
      decreaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • decreaseReplicaCount

      default CompletableFuture<DecreaseReplicaCountResponse> decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest)

      Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

      Parameters:
      decreaseReplicaCountRequest -
      Returns:
      A Java Future containing the result of the DecreaseReplicaCount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • decreaseReplicaCount

      default CompletableFuture<DecreaseReplicaCountResponse> decreaseReplicaCount(Consumer<DecreaseReplicaCountRequest.Builder> decreaseReplicaCountRequest)

      Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (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()

      Parameters:
      decreaseReplicaCountRequest - A Consumer that will call methods on DecreaseReplicaCountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DecreaseReplicaCount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • deleteCacheCluster

      default CompletableFuture<DeleteCacheClusterResponse> deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest)

      Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

      This operation is not valid for:

      • Valkey or Redis OSS (cluster mode enabled) clusters

      • Valkey or Redis OSS (cluster mode disabled) clusters

      • A cluster that is the last read replica of a replication group

      • A cluster that is the primary node of a replication group

      • A node group (shard) that has Multi-AZ mode enabled

      • A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group

      • A cluster that is not in the available state

      Parameters:
      deleteCacheClusterRequest - Represents the input of a DeleteCacheCluster operation.
      Returns:
      A Java Future containing the result of the DeleteCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        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.
      See Also:

    • deleteCacheCluster

      default CompletableFuture<DeleteCacheClusterResponse> deleteCacheCluster(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest)

      Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

      This operation is not valid for:

      • Valkey or Redis OSS (cluster mode enabled) clusters

      • Valkey or Redis OSS (cluster mode disabled) clusters

      • A cluster that is the last read replica of a replication group

      • A cluster that is the primary node of a replication group

      • A node group (shard) that has Multi-AZ mode enabled

      • A cluster from a Valkey or Redis OSS (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()

      Parameters:
      deleteCacheClusterRequest - A Consumer that will call methods on DeleteCacheClusterRequest.Builder to create a request. Represents the input of a DeleteCacheCluster operation.
      Returns:
      A Java Future containing the result of the DeleteCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        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.
      See Also:

    • deleteCacheParameterGroup

      default CompletableFuture<DeleteCacheParameterGroupResponse> deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest)

      Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

      Parameters:
      deleteCacheParameterGroupRequest - Represents the input of a DeleteCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCacheParameterGroup

      default CompletableFuture<DeleteCacheParameterGroupResponse> deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest)

      Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.


      This is a convenience which creates an instance of the DeleteCacheParameterGroupRequest.Builder avoiding the need to create one manually via DeleteCacheParameterGroupRequest.builder()

      Parameters:
      deleteCacheParameterGroupRequest - A Consumer that will call methods on DeleteCacheParameterGroupRequest.Builder to create a request. Represents the input of a DeleteCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCacheSecurityGroup

      default CompletableFuture<DeleteCacheSecurityGroupResponse> deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest)

      Deletes a cache security group.

      You cannot delete a cache security group if it is associated with any clusters.

      Parameters:
      deleteCacheSecurityGroupRequest - Represents the input of a DeleteCacheSecurityGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheSecurityGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCacheSecurityGroup

      default CompletableFuture<DeleteCacheSecurityGroupResponse> deleteCacheSecurityGroup(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest)

      Deletes a cache security group.

      You cannot delete a cache security group if it is associated with any clusters.


      This is a convenience which creates an instance of the DeleteCacheSecurityGroupRequest.Builder avoiding the need to create one manually via DeleteCacheSecurityGroupRequest.builder()

      Parameters:
      deleteCacheSecurityGroupRequest - A Consumer that will call methods on DeleteCacheSecurityGroupRequest.Builder to create a request. Represents the input of a DeleteCacheSecurityGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheSecurityGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCacheSubnetGroup

      default CompletableFuture<DeleteCacheSubnetGroupResponse> deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest)

      Deletes a cache subnet group.

      You cannot delete a default cache subnet group or one that is associated with any clusters.

      Parameters:
      deleteCacheSubnetGroupRequest - Represents the input of a DeleteCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCacheSubnetGroup

      default CompletableFuture<DeleteCacheSubnetGroupResponse> deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest)

      Deletes a cache subnet group.

      You cannot delete a default cache subnet group or one that is associated with any clusters.


      This is a convenience which creates an instance of the DeleteCacheSubnetGroupRequest.Builder avoiding the need to create one manually via DeleteCacheSubnetGroupRequest.builder()

      Parameters:
      deleteCacheSubnetGroupRequest - A Consumer that will call methods on DeleteCacheSubnetGroupRequest.Builder to create a request. Represents the input of a DeleteCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the DeleteCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteGlobalReplicationGroup

      default CompletableFuture<DeleteGlobalReplicationGroupResponse> deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest)

      Deleting a Global datastore is a two-step process:

      • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

      • Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

      Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

      When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

      Parameters:
      deleteGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • deleteGlobalReplicationGroup

      default CompletableFuture<DeleteGlobalReplicationGroupResponse> deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest)

      Deleting a Global datastore is a two-step process:

      • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

      • Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

      Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

      When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.


      This is a convenience which creates an instance of the DeleteGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via DeleteGlobalReplicationGroupRequest.builder()

      Parameters:
      deleteGlobalReplicationGroupRequest - A Consumer that will call methods on DeleteGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • deleteReplicationGroup

      default CompletableFuture<DeleteReplicationGroupResponse> deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest)

      Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

      When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

      • CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

      • This operation is valid for Redis OSS only.

      Parameters:
      deleteReplicationGroupRequest - Represents the input of a DeleteReplicationGroup operation.
      Returns:
      A Java Future containing the result of the DeleteReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        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.
      See Also:

    • deleteReplicationGroup

      default CompletableFuture<DeleteReplicationGroupResponse> deleteReplicationGroup(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest)

      Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

      When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

      • CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

      • This operation is valid for Redis OSS only.


      This is a convenience which creates an instance of the DeleteReplicationGroupRequest.Builder avoiding the need to create one manually via DeleteReplicationGroupRequest.builder()

      Parameters:
      deleteReplicationGroupRequest - A Consumer that will call methods on DeleteReplicationGroupRequest.Builder to create a request. Represents the input of a DeleteReplicationGroup operation.
      Returns:
      A Java Future containing the result of the DeleteReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Valkey or Redis OSS cluster running on a cache.t1.micro cache node.

        • Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.

        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.
      See Also:

    • deleteServerlessCache

      default CompletableFuture<DeleteServerlessCacheResponse> deleteServerlessCache(DeleteServerlessCacheRequest deleteServerlessCacheRequest)

      Deletes a specified existing serverless cache.

      CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

      Parameters:
      deleteServerlessCacheRequest -
      Returns:
      A Java Future containing the result of the DeleteServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • deleteServerlessCache

      default CompletableFuture<DeleteServerlessCacheResponse> deleteServerlessCache(Consumer<DeleteServerlessCacheRequest.Builder> deleteServerlessCacheRequest)

      Deletes a specified existing serverless cache.

      CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.


      This is a convenience which creates an instance of the DeleteServerlessCacheRequest.Builder avoiding the need to create one manually via DeleteServerlessCacheRequest.builder()

      Parameters:
      deleteServerlessCacheRequest - A Consumer that will call methods on DeleteServerlessCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotAlreadyExistsException A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • deleteServerlessCacheSnapshot

      default CompletableFuture<DeleteServerlessCacheSnapshotResponse> deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest)

      Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

      Parameters:
      deleteServerlessCacheSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • deleteServerlessCacheSnapshot

      default CompletableFuture<DeleteServerlessCacheSnapshotResponse> deleteServerlessCacheSnapshot(Consumer<DeleteServerlessCacheSnapshotRequest.Builder> deleteServerlessCacheSnapshotRequest)

      Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.


      This is a convenience which creates an instance of the DeleteServerlessCacheSnapshotRequest.Builder avoiding the need to create one manually via DeleteServerlessCacheSnapshotRequest.builder()

      Parameters:
      deleteServerlessCacheSnapshotRequest - A Consumer that will call methods on DeleteServerlessCacheSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • deleteSnapshot

      default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest)

      Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

      This operation is valid for Valkey or Redis OSS only.

      Parameters:
      deleteSnapshotRequest - Represents the input of a DeleteSnapshot operation.
      Returns:
      A Java Future containing the result of the DeleteSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSnapshot

      default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest)

      Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

      This operation is valid for Valkey or Redis OSS only.


      This is a convenience which creates an instance of the DeleteSnapshotRequest.Builder avoiding the need to create one manually via DeleteSnapshotRequest.builder()

      Parameters:
      deleteSnapshotRequest - A Consumer that will call methods on DeleteSnapshotRequest.Builder to create a request. Represents the input of a DeleteSnapshot operation.
      Returns:
      A Java Future containing the result of the DeleteSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

      Parameters:
      deleteUserRequest -
      Returns:
      A Java Future containing the result of the DeleteUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidUserStateException The user is not in active state.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • DefaultUserAssociatedToUserGroupException The default user assigned to the user 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.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).


      This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

      Parameters:
      deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidUserStateException The user is not in active state.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • InvalidParameterValueException The value for a parameter is invalid.
      • DefaultUserAssociatedToUserGroupException The default user assigned to the user 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.
      See Also:

    • deleteUserGroup

      default CompletableFuture<DeleteUserGroupResponse> deleteUserGroup(DeleteUserGroupRequest deleteUserGroupRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

      Parameters:
      deleteUserGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • InvalidUserGroupStateException The user group is not in an active state.
      • 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.
      See Also:

    • deleteUserGroup

      default CompletableFuture<DeleteUserGroupResponse> deleteUserGroup(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest)

      For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).


      This is a convenience which creates an instance of the DeleteUserGroupRequest.Builder avoiding the need to create one manually via DeleteUserGroupRequest.builder()

      Parameters:
      deleteUserGroupRequest - A Consumer that will call methods on DeleteUserGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • InvalidUserGroupStateException The user group is not in an active state.
      • 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.
      See Also:

    • describeCacheClusters

      default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest)

      Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

      By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

      If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

      If the cluster is in the deleting state, only cluster-level information is displayed.

      If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

      If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

      Parameters:
      describeCacheClustersRequest - Represents the input of a DescribeCacheClusters operation.
      Returns:
      A Java Future containing the result of the DescribeCacheClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheClusters

      default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)

      Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

      By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

      If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

      If the cluster is in the deleting state, only cluster-level information is displayed.

      If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

      If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.


      This is a convenience which creates an instance of the DescribeCacheClustersRequest.Builder avoiding the need to create one manually via DescribeCacheClustersRequest.builder()

      Parameters:
      describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersRequest.Builder to create a request. Represents the input of a DescribeCacheClusters operation.
      Returns:
      A Java Future containing the result of the DescribeCacheClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheClusters

      default CompletableFuture<DescribeCacheClustersResponse> describeCacheClusters()

      Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

      By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

      If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

      If the cluster is in the deleting state, only cluster-level information is displayed.

      If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

      If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

      Returns:
      A Java Future containing the result of the DescribeCacheClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheClustersPaginator

      default DescribeCacheClustersPublisher describeCacheClustersPaginator()

      This is a variant of describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheClustersPaginator

      default DescribeCacheClustersPublisher describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest)

      This is a variant of describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation.

      Parameters:
      describeCacheClustersRequest - Represents the input of a DescribeCacheClusters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheClustersPaginator

      default DescribeCacheClustersPublisher describeCacheClustersPaginator(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)

      This is a variant of describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersPublisher publisher = client.describeCacheClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheClustersRequest.Builder avoiding the need to create one manually via DescribeCacheClustersRequest.builder()

      Parameters:
      describeCacheClustersRequest - A Consumer that will call methods on DescribeCacheClustersRequest.Builder to create a request. Represents the input of a DescribeCacheClusters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersions

      default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)

      Returns a list of the available cache engines and their versions.

      Parameters:
      describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.
      Returns:
      A Java Future containing the result of the DescribeCacheEngineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersions

      default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)

      Returns a list of the available cache engines and their versions.


      This is a convenience which creates an instance of the DescribeCacheEngineVersionsRequest.Builder avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()

      Parameters:
      describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsRequest.Builder to create a request. Represents the input of a DescribeCacheEngineVersions operation.
      Returns:
      A Java Future containing the result of the DescribeCacheEngineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersions

      default CompletableFuture<DescribeCacheEngineVersionsResponse> describeCacheEngineVersions()

      Returns a list of the available cache engines and their versions.

      Returns:
      A Java Future containing the result of the DescribeCacheEngineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersionsPaginator

      default DescribeCacheEngineVersionsPublisher describeCacheEngineVersionsPaginator()

      This is a variant of describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersionsPaginator

      default DescribeCacheEngineVersionsPublisher describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest)

      This is a variant of describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation.

      Parameters:
      describeCacheEngineVersionsRequest - Represents the input of a DescribeCacheEngineVersions operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheEngineVersionsPaginator

      default DescribeCacheEngineVersionsPublisher describeCacheEngineVersionsPaginator(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest)

      This is a variant of describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsPublisher publisher = client.describeCacheEngineVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheEngineVersionsRequest.Builder avoiding the need to create one manually via DescribeCacheEngineVersionsRequest.builder()

      Parameters:
      describeCacheEngineVersionsRequest - A Consumer that will call methods on DescribeCacheEngineVersionsRequest.Builder to create a request. Represents the input of a DescribeCacheEngineVersions operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroups

      default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)

      Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

      Parameters:
      describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroups

      default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)

      Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.


      This is a convenience which creates an instance of the DescribeCacheParameterGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()

      Parameters:
      describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheParameterGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroups

      default CompletableFuture<DescribeCacheParameterGroupsResponse> describeCacheParameterGroups()

      Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

      Returns:
      A Java Future containing the result of the DescribeCacheParameterGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroupsPaginator

      default DescribeCacheParameterGroupsPublisher describeCacheParameterGroupsPaginator()

      This is a variant of describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroupsPaginator

      default DescribeCacheParameterGroupsPublisher describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest)

      This is a variant of describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation.

      Parameters:
      describeCacheParameterGroupsRequest - Represents the input of a DescribeCacheParameterGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameterGroupsPaginator

      default DescribeCacheParameterGroupsPublisher describeCacheParameterGroupsPaginator(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest)

      This is a variant of describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsPublisher publisher = client.describeCacheParameterGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheParameterGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheParameterGroupsRequest.builder()

      Parameters:
      describeCacheParameterGroupsRequest - A Consumer that will call methods on DescribeCacheParameterGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheParameterGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameters

      default CompletableFuture<DescribeCacheParametersResponse> describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest)

      Returns the detailed parameter list for a particular cache parameter group.

      Parameters:
      describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.
      Returns:
      A Java Future containing the result of the DescribeCacheParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParameters

      default CompletableFuture<DescribeCacheParametersResponse> describeCacheParameters(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest)

      Returns the detailed parameter list for a particular cache parameter group.


      This is a convenience which creates an instance of the DescribeCacheParametersRequest.Builder avoiding the need to create one manually via DescribeCacheParametersRequest.builder()

      Parameters:
      describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersRequest.Builder to create a request. Represents the input of a DescribeCacheParameters operation.
      Returns:
      A Java Future containing the result of the DescribeCacheParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParametersPaginator

      default DescribeCacheParametersPublisher describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest)

      This is a variant of describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest) operation.

      Parameters:
      describeCacheParametersRequest - Represents the input of a DescribeCacheParameters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheParametersPaginator

      default DescribeCacheParametersPublisher describeCacheParametersPaginator(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest)

      This is a variant of describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersPublisher publisher = client.describeCacheParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheParametersRequest.Builder avoiding the need to create one manually via DescribeCacheParametersRequest.builder()

      Parameters:
      describeCacheParametersRequest - A Consumer that will call methods on DescribeCacheParametersRequest.Builder to create a request. Represents the input of a DescribeCacheParameters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSecurityGroups

      default CompletableFuture<DescribeCacheSecurityGroupsResponse> describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)

      Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

      Parameters:
      describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSecurityGroups

      default CompletableFuture<DescribeCacheSecurityGroupsResponse> describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)

      Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup


      This is a convenience which creates an instance of the DescribeCacheSecurityGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()

      Parameters:
      describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheSecurityGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheSecurityGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSecurityGroupsPaginator

      default DescribeCacheSecurityGroupsPublisher describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest)

      This is a variant of describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest) operation.

      Parameters:
      describeCacheSecurityGroupsRequest - Represents the input of a DescribeCacheSecurityGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSecurityGroupsPaginator

      default DescribeCacheSecurityGroupsPublisher describeCacheSecurityGroupsPaginator(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest)

      This is a variant of describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsPublisher publisher = client.describeCacheSecurityGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheSecurityGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheSecurityGroupsRequest.builder()

      Parameters:
      describeCacheSecurityGroupsRequest - A Consumer that will call methods on DescribeCacheSecurityGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheSecurityGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroups

      default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)

      Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

      Parameters:
      describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroups

      default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)

      Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.


      This is a convenience which creates an instance of the DescribeCacheSubnetGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()

      Parameters:
      describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheSubnetGroups operation.
      Returns:
      A Java Future containing the result of the DescribeCacheSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroups

      default CompletableFuture<DescribeCacheSubnetGroupsResponse> describeCacheSubnetGroups()

      Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

      Returns:
      A Java Future containing the result of the DescribeCacheSubnetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroupsPaginator

      default DescribeCacheSubnetGroupsPublisher describeCacheSubnetGroupsPaginator()

      This is a variant of describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroupsPaginator

      default DescribeCacheSubnetGroupsPublisher describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest)

      This is a variant of describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation.

      Parameters:
      describeCacheSubnetGroupsRequest - Represents the input of a DescribeCacheSubnetGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCacheSubnetGroupsPaginator

      default DescribeCacheSubnetGroupsPublisher describeCacheSubnetGroupsPaginator(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest)

      This is a variant of describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsPublisher publisher = client.describeCacheSubnetGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeCacheSubnetGroupsRequest.Builder avoiding the need to create one manually via DescribeCacheSubnetGroupsRequest.builder()

      Parameters:
      describeCacheSubnetGroupsRequest - A Consumer that will call methods on DescribeCacheSubnetGroupsRequest.Builder to create a request. Represents the input of a DescribeCacheSubnetGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEngineDefaultParameters

      default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)

      Returns the default engine and system parameter information for the specified cache engine.

      Parameters:
      describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.
      Returns:
      A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEngineDefaultParameters

      default CompletableFuture<DescribeEngineDefaultParametersResponse> describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)

      Returns the default engine and system parameter information for the specified cache engine.


      This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()

      Parameters:
      describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersRequest.Builder to create a request. Represents the input of a DescribeEngineDefaultParameters operation.
      Returns:
      A Java Future containing the result of the DescribeEngineDefaultParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEngineDefaultParametersPaginator

      default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)

      This is a variant of describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest) operation.

      Parameters:
      describeEngineDefaultParametersRequest - Represents the input of a DescribeEngineDefaultParameters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEngineDefaultParametersPaginator

      default DescribeEngineDefaultParametersPublisher describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest)

      This is a variant of describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersPublisher publisher = client.describeEngineDefaultParametersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest) operation.


      This is a convenience which creates an instance of the DescribeEngineDefaultParametersRequest.Builder avoiding the need to create one manually via DescribeEngineDefaultParametersRequest.builder()

      Parameters:
      describeEngineDefaultParametersRequest - A Consumer that will call methods on DescribeEngineDefaultParametersRequest.Builder to create a request. Represents the input of a DescribeEngineDefaultParameters operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)

      Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

      By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

      Parameters:
      describeEventsRequest - Represents the input of a DescribeEvents operation.
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

      By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.


      This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request. Represents the input of a DescribeEvents operation.
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents()

      Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

      By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator()

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.

      Parameters:
      describeEventsRequest - Represents the input of a DescribeEvents operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest) operation.


      This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request. Represents the input of a DescribeEvents operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeGlobalReplicationGroups

      default CompletableFuture<DescribeGlobalReplicationGroupsResponse> describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)

      Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

      Parameters:
      describeGlobalReplicationGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeGlobalReplicationGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore 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.
      See Also:

    • describeGlobalReplicationGroups

      default CompletableFuture<DescribeGlobalReplicationGroupsResponse> describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)

      Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.


      This is a convenience which creates an instance of the DescribeGlobalReplicationGroupsRequest.Builder avoiding the need to create one manually via DescribeGlobalReplicationGroupsRequest.builder()

      Parameters:
      describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeGlobalReplicationGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore 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.
      See Also:

    • describeGlobalReplicationGroupsPaginator

      default DescribeGlobalReplicationGroupsPublisher describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest)

      This is a variant of describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest) operation.

      Parameters:
      describeGlobalReplicationGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore 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.
      See Also:

    • describeGlobalReplicationGroupsPaginator

      default DescribeGlobalReplicationGroupsPublisher describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest)

      This is a variant of describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsPublisher publisher = client.describeGlobalReplicationGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeGlobalReplicationGroupsRequest.Builder avoiding the need to create one manually via DescribeGlobalReplicationGroupsRequest.builder()

      Parameters:
      describeGlobalReplicationGroupsRequest - A Consumer that will call methods on DescribeGlobalReplicationGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore 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.
      See Also:

    • describeReplicationGroups

      default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)

      Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

      This operation is valid for Valkey or Redis OSS only.

      Parameters:
      describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.
      Returns:
      A Java Future containing the result of the DescribeReplicationGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReplicationGroups

      default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)

      Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

      This operation is valid for Valkey or Redis OSS only.


      This is a convenience which creates an instance of the DescribeReplicationGroupsRequest.Builder avoiding the need to create one manually via DescribeReplicationGroupsRequest.builder()

      Parameters:
      describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsRequest.Builder to create a request. Represents the input of a DescribeReplicationGroups operation.
      Returns:
      A Java Future containing the result of the DescribeReplicationGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReplicationGroups

      default CompletableFuture<DescribeReplicationGroupsResponse> describeReplicationGroups()

      Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

      This operation is valid for Valkey or Redis OSS only.

      Returns:
      A Java Future containing the result of the DescribeReplicationGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReplicationGroupsPaginator

      default DescribeReplicationGroupsPublisher describeReplicationGroupsPaginator()

      This is a variant of describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReplicationGroupsPaginator

      default DescribeReplicationGroupsPublisher describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)

      This is a variant of describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation.

      Parameters:
      describeReplicationGroupsRequest - Represents the input of a DescribeReplicationGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReplicationGroupsPaginator

      default DescribeReplicationGroupsPublisher describeReplicationGroupsPaginator(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)

      This is a variant of describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsPublisher publisher = client.describeReplicationGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeReplicationGroupsRequest.Builder avoiding the need to create one manually via DescribeReplicationGroupsRequest.builder()

      Parameters:
      describeReplicationGroupsRequest - A Consumer that will call methods on DescribeReplicationGroupsRequest.Builder to create a request. Represents the input of a DescribeReplicationGroups operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodes

      default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)

      Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

      Parameters:
      describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.
      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodes

      default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)

      Returns information about reserved cache nodes for this account, or about a specified reserved cache node.


      This is a convenience which creates an instance of the DescribeReservedCacheNodesRequest.Builder avoiding the need to create one manually via DescribeReservedCacheNodesRequest.builder()

      Parameters:
      describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesRequest.Builder to create a request. Represents the input of a DescribeReservedCacheNodes operation.
      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodes

      default CompletableFuture<DescribeReservedCacheNodesResponse> describeReservedCacheNodes()

      Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferings

      default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)

      Lists available reserved cache node offerings.

      Parameters:
      describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.
      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodesOfferings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferings

      default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)

      Lists available reserved cache node offerings.


      This is a convenience which creates an instance of the DescribeReservedCacheNodesOfferingsRequest.Builder avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()

      Parameters:
      describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsRequest.Builder to create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.
      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodesOfferings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferings

      default CompletableFuture<DescribeReservedCacheNodesOfferingsResponse> describeReservedCacheNodesOfferings()

      Lists available reserved cache node offerings.

      Returns:
      A Java Future containing the result of the DescribeReservedCacheNodesOfferings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferingsPaginator

      default DescribeReservedCacheNodesOfferingsPublisher describeReservedCacheNodesOfferingsPaginator()

      This is a variant of describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferingsPaginator

      default DescribeReservedCacheNodesOfferingsPublisher describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest)

      This is a variant of describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation.

      Parameters:
      describeReservedCacheNodesOfferingsRequest - Represents the input of a DescribeReservedCacheNodesOfferings operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesOfferingsPaginator

      default DescribeReservedCacheNodesOfferingsPublisher describeReservedCacheNodesOfferingsPaginator(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest)

      This is a variant of describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsPublisher publisher = client.describeReservedCacheNodesOfferingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest) operation.


      This is a convenience which creates an instance of the DescribeReservedCacheNodesOfferingsRequest.Builder avoiding the need to create one manually via DescribeReservedCacheNodesOfferingsRequest.builder()

      Parameters:
      describeReservedCacheNodesOfferingsRequest - A Consumer that will call methods on DescribeReservedCacheNodesOfferingsRequest.Builder to create a request. Represents the input of a DescribeReservedCacheNodesOfferings operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesPaginator

      default DescribeReservedCacheNodesPublisher describeReservedCacheNodesPaginator()

      This is a variant of describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesPaginator

      default DescribeReservedCacheNodesPublisher describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest)

      This is a variant of describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation.

      Parameters:
      describeReservedCacheNodesRequest - Represents the input of a DescribeReservedCacheNodes operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeReservedCacheNodesPaginator

      default DescribeReservedCacheNodesPublisher describeReservedCacheNodesPaginator(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest)

      This is a variant of describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesPublisher publisher = client.describeReservedCacheNodesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest) operation.


      This is a convenience which creates an instance of the DescribeReservedCacheNodesRequest.Builder avoiding the need to create one manually via DescribeReservedCacheNodesRequest.builder()

      Parameters:
      describeReservedCacheNodesRequest - A Consumer that will call methods on DescribeReservedCacheNodesRequest.Builder to create a request. Represents the input of a DescribeReservedCacheNodes operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeServerlessCacheSnapshots

      default CompletableFuture<DescribeServerlessCacheSnapshotsResponse> describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest)

      Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

      Parameters:
      describeServerlessCacheSnapshotsRequest -
      Returns:
      A Java Future containing the result of the DescribeServerlessCacheSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • describeServerlessCacheSnapshots

      default CompletableFuture<DescribeServerlessCacheSnapshotsResponse> describeServerlessCacheSnapshots(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest)

      Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.


      This is a convenience which creates an instance of the DescribeServerlessCacheSnapshotsRequest.Builder avoiding the need to create one manually via DescribeServerlessCacheSnapshotsRequest.builder()

      Parameters:
      describeServerlessCacheSnapshotsRequest - A Consumer that will call methods on DescribeServerlessCacheSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServerlessCacheSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • describeServerlessCacheSnapshotsPaginator

      default DescribeServerlessCacheSnapshotsPublisher describeServerlessCacheSnapshotsPaginator(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest)

      This is a variant of describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsPublisher publisher = client.describeServerlessCacheSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsPublisher publisher = client.describeServerlessCacheSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest) operation.

      Parameters:
      describeServerlessCacheSnapshotsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • describeServerlessCacheSnapshotsPaginator

      default DescribeServerlessCacheSnapshotsPublisher describeServerlessCacheSnapshotsPaginator(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest)

      This is a variant of describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsPublisher publisher = client.describeServerlessCacheSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsPublisher publisher = client.describeServerlessCacheSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest) operation.


      This is a convenience which creates an instance of the DescribeServerlessCacheSnapshotsRequest.Builder avoiding the need to create one manually via DescribeServerlessCacheSnapshotsRequest.builder()

      Parameters:
      describeServerlessCacheSnapshotsRequest - A Consumer that will call methods on DescribeServerlessCacheSnapshotsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • describeServerlessCaches

      default CompletableFuture<DescribeServerlessCachesResponse> describeServerlessCaches(DescribeServerlessCachesRequest describeServerlessCachesRequest)

      Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.

      Parameters:
      describeServerlessCachesRequest -
      Returns:
      A Java Future containing the result of the DescribeServerlessCaches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or 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.
      See Also:

    • describeServerlessCaches

      default CompletableFuture<DescribeServerlessCachesResponse> describeServerlessCaches(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest)

      Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.


      This is a convenience which creates an instance of the DescribeServerlessCachesRequest.Builder avoiding the need to create one manually via DescribeServerlessCachesRequest.builder()

      Parameters:
      describeServerlessCachesRequest - A Consumer that will call methods on DescribeServerlessCachesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServerlessCaches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or 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.
      See Also:

    • describeServerlessCachesPaginator

      default DescribeServerlessCachesPublisher describeServerlessCachesPaginator(DescribeServerlessCachesRequest describeServerlessCachesRequest)

      This is a variant of describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesPublisher publisher = client.describeServerlessCachesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesPublisher publisher = client.describeServerlessCachesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest) operation.

      Parameters:
      describeServerlessCachesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or 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.
      See Also:

    • describeServerlessCachesPaginator

      default DescribeServerlessCachesPublisher describeServerlessCachesPaginator(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest)

      This is a variant of describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesPublisher publisher = client.describeServerlessCachesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesPublisher publisher = client.describeServerlessCachesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest) operation.


      This is a convenience which creates an instance of the DescribeServerlessCachesRequest.Builder avoiding the need to create one manually via DescribeServerlessCachesRequest.builder()

      Parameters:
      describeServerlessCachesRequest - A Consumer that will call methods on DescribeServerlessCachesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or 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.
      See Also:

    • describeServiceUpdates

      default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)

      Returns details of the service updates

      Parameters:
      describeServiceUpdatesRequest -
      Returns:
      A Java Future containing the result of the DescribeServiceUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't 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.
      See Also:

    • describeServiceUpdates

      default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)

      Returns details of the service updates


      This is a convenience which creates an instance of the DescribeServiceUpdatesRequest.Builder avoiding the need to create one manually via DescribeServiceUpdatesRequest.builder()

      Parameters:
      describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServiceUpdates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't 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.
      See Also:

    • describeServiceUpdatesPaginator

      default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest)

      This is a variant of describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest) operation.

      Parameters:
      describeServiceUpdatesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't 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.
      See Also:

    • describeServiceUpdatesPaginator

      default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest)

      This is a variant of describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest) operation.


      This is a convenience which creates an instance of the DescribeServiceUpdatesRequest.Builder avoiding the need to create one manually via DescribeServiceUpdatesRequest.builder()

      Parameters:
      describeServiceUpdatesRequest - A Consumer that will call methods on DescribeServiceUpdatesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceUpdateNotFoundException The service update doesn't 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.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest)

      Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

      This operation is valid for Valkey or Redis OSS only.

      Parameters:
      describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.
      Returns:
      A Java Future containing the result of the DescribeSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)

      Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

      This operation is valid for Valkey or Redis OSS only.


      This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request. Represents the input of a DescribeSnapshotsMessage operation.
      Returns:
      A Java Future containing the result of the DescribeSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSnapshots

      default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots()

      Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

      This operation is valid for Valkey or Redis OSS only.

      Returns:
      A Java Future containing the result of the DescribeSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator()

      This is a variant of describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation.

      Parameters:
      describeSnapshotsRequest - Represents the input of a DescribeSnapshotsMessage operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSnapshotsPaginator

      default DescribeSnapshotsPublisher describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest)

      This is a variant of describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest) operation.


      This is a convenience which creates an instance of the DescribeSnapshotsRequest.Builder avoiding the need to create one manually via DescribeSnapshotsRequest.builder()

      Parameters:
      describeSnapshotsRequest - A Consumer that will call methods on DescribeSnapshotsRequest.Builder to create a request. Represents the input of a DescribeSnapshotsMessage operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeUpdateActions

      default CompletableFuture<DescribeUpdateActionsResponse> describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest)

      Returns details of the update actions

      Parameters:
      describeUpdateActionsRequest -
      Returns:
      A Java Future containing the result of the DescribeUpdateActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeUpdateActions

      default CompletableFuture<DescribeUpdateActionsResponse> describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)

      Returns details of the update actions


      This is a convenience which creates an instance of the DescribeUpdateActionsRequest.Builder avoiding the need to create one manually via DescribeUpdateActionsRequest.builder()

      Parameters:
      describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUpdateActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeUpdateActionsPaginator

      default DescribeUpdateActionsPublisher describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest)

      This is a variant of describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest) operation.

      Parameters:
      describeUpdateActionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeUpdateActionsPaginator

      default DescribeUpdateActionsPublisher describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest)

      This is a variant of describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsPublisher publisher = client.describeUpdateActionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest) operation.


      This is a convenience which creates an instance of the DescribeUpdateActionsRequest.Builder avoiding the need to create one manually via DescribeUpdateActionsRequest.builder()

      Parameters:
      describeUpdateActionsRequest - A Consumer that will call methods on DescribeUpdateActionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeUserGroups

      default CompletableFuture<DescribeUserGroupsResponse> describeUserGroups(DescribeUserGroupsRequest describeUserGroupsRequest)

      Returns a list of user groups.

      Parameters:
      describeUserGroupsRequest -
      Returns:
      A Java Future containing the result of the DescribeUserGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUserGroups

      default CompletableFuture<DescribeUserGroupsResponse> describeUserGroups(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)

      Returns a list of user groups.


      This is a convenience which creates an instance of the DescribeUserGroupsRequest.Builder avoiding the need to create one manually via DescribeUserGroupsRequest.builder()

      Parameters:
      describeUserGroupsRequest - A Consumer that will call methods on DescribeUserGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUserGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUserGroupsPaginator

      default DescribeUserGroupsPublisher describeUserGroupsPaginator(DescribeUserGroupsRequest describeUserGroupsRequest)

      This is a variant of describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest) operation.

      Parameters:
      describeUserGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUserGroupsPaginator

      default DescribeUserGroupsPublisher describeUserGroupsPaginator(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest)

      This is a variant of describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsPublisher publisher = client.describeUserGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest) operation.


      This is a convenience which creates an instance of the DescribeUserGroupsRequest.Builder avoiding the need to create one manually via DescribeUserGroupsRequest.builder()

      Parameters:
      describeUserGroupsRequest - A Consumer that will call methods on DescribeUserGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUsers

      default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest)

      Returns a list of users.

      Parameters:
      describeUsersRequest -
      Returns:
      A Java Future containing the result of the DescribeUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUsers

      default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)

      Returns a list of users.


      This is a convenience which creates an instance of the DescribeUsersRequest.Builder avoiding the need to create one manually via DescribeUsersRequest.builder()

      Parameters:
      describeUsersRequest - A Consumer that will call methods on DescribeUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUsers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUsersPaginator

      default DescribeUsersPublisher describeUsersPaginator(DescribeUsersRequest describeUsersRequest)

      This is a variant of describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation.

      Parameters:
      describeUsersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • describeUsersPaginator

      default DescribeUsersPublisher describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest)

      This is a variant of describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticache.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest) operation.


      This is a convenience which creates an instance of the DescribeUsersRequest.Builder avoiding the need to create one manually via DescribeUsersRequest.builder()

      Parameters:
      describeUsersRequest - A Consumer that will call methods on DescribeUsersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • disassociateGlobalReplicationGroup

      default CompletableFuture<DisassociateGlobalReplicationGroupResponse> disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest)

      Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

      Parameters:
      disassociateGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the DisassociateGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • disassociateGlobalReplicationGroup

      default CompletableFuture<DisassociateGlobalReplicationGroupResponse> disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest)

      Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.


      This is a convenience which creates an instance of the DisassociateGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via DisassociateGlobalReplicationGroupRequest.builder()

      Parameters:
      disassociateGlobalReplicationGroupRequest - A Consumer that will call methods on DisassociateGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • exportServerlessCacheSnapshot

      default CompletableFuture<ExportServerlessCacheSnapshotResponse> exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest)

      Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.

      Parameters:
      exportServerlessCacheSnapshotRequest -
      Returns:
      A Java Future containing the result of the ExportServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • exportServerlessCacheSnapshot

      default CompletableFuture<ExportServerlessCacheSnapshotResponse> exportServerlessCacheSnapshot(Consumer<ExportServerlessCacheSnapshotRequest.Builder> exportServerlessCacheSnapshotRequest)

      Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.


      This is a convenience which creates an instance of the ExportServerlessCacheSnapshotRequest.Builder avoiding the need to create one manually via ExportServerlessCacheSnapshotRequest.builder()

      Parameters:
      exportServerlessCacheSnapshotRequest - A Consumer that will call methods on ExportServerlessCacheSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportServerlessCacheSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • failoverGlobalReplicationGroup

      default CompletableFuture<FailoverGlobalReplicationGroupResponse> failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest)

      Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

      Parameters:
      failoverGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the FailoverGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • failoverGlobalReplicationGroup

      default CompletableFuture<FailoverGlobalReplicationGroupResponse> failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest)

      Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.


      This is a convenience which creates an instance of the FailoverGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via FailoverGlobalReplicationGroupRequest.builder()

      Parameters:
      failoverGlobalReplicationGroupRequest - A Consumer that will call methods on FailoverGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the FailoverGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only 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.
      See Also:

    • increaseNodeGroupsInGlobalReplicationGroup

      default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest)

      Increase the number of node groups in the Global datastore

      Parameters:
      increaseNodeGroupsInGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • increaseNodeGroupsInGlobalReplicationGroup

      default CompletableFuture<IncreaseNodeGroupsInGlobalReplicationGroupResponse> increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest)

      Increase the number of node groups in the Global datastore


      This is a convenience which creates an instance of the IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via IncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()

      Parameters:
      increaseNodeGroupsInGlobalReplicationGroupRequest - A Consumer that will call methods on IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • increaseReplicaCount

      default CompletableFuture<IncreaseReplicaCountResponse> increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest)

      Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

      Parameters:
      increaseReplicaCountRequest -
      Returns:
      A Java Future containing the result of the IncreaseReplicaCount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • increaseReplicaCount

      default CompletableFuture<IncreaseReplicaCountResponse> increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest)

      Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (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()

      Parameters:
      increaseReplicaCountRequest - A Consumer that will call methods on IncreaseReplicaCountRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the IncreaseReplicaCount operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • listAllowedNodeTypeModifications

      default CompletableFuture<ListAllowedNodeTypeModificationsResponse> listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest)

      Lists all available node types that you can scale with your cluster's 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.

      Parameters:
      listAllowedNodeTypeModificationsRequest - The input parameters for the ListAllowedNodeTypeModifications operation.
      Returns:
      A Java Future containing the result of the ListAllowedNodeTypeModifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAllowedNodeTypeModifications

      default CompletableFuture<ListAllowedNodeTypeModificationsResponse> listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest)

      Lists all available node types that you can scale with your cluster's 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()

      Parameters:
      listAllowedNodeTypeModificationsRequest - A Consumer that will call methods on ListAllowedNodeTypeModificationsRequest.Builder to create a request. The input parameters for the ListAllowedNodeTypeModifications operation.
      Returns:
      A Java Future containing the result of the ListAllowedNodeTypeModifications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags currently on a named resource.

      A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.

      If the cluster is not in the available state, ListTagsForResource returns an error.

      Parameters:
      listTagsForResourceRequest - The input parameters for the ListTagsForResource operation.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags currently on a named resource.

      A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource -level permissions.

      If the cluster is not in the available state, ListTagsForResource returns an error.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. The input parameters for the ListTagsForResource operation.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • modifyCacheCluster

      default CompletableFuture<ModifyCacheClusterResponse> modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest)

      Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

      Parameters:
      modifyCacheClusterRequest - Represents the input of a ModifyCacheCluster operation.
      Returns:
      A Java Future containing the result of the ModifyCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • modifyCacheCluster

      default CompletableFuture<ModifyCacheClusterResponse> modifyCacheCluster(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest)

      Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.


      This is a convenience which creates an instance of the ModifyCacheClusterRequest.Builder avoiding the need to create one manually via ModifyCacheClusterRequest.builder()

      Parameters:
      modifyCacheClusterRequest - A Consumer that will call methods on ModifyCacheClusterRequest.Builder to create a request. Represents the input of a ModifyCacheCluster operation.
      Returns:
      A Java Future containing the result of the ModifyCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • modifyCacheParameterGroup

      default CompletableFuture<ModifyCacheParameterGroupResponse> modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest)

      Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

      Parameters:
      modifyCacheParameterGroupRequest - Represents the input of a ModifyCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the ModifyCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 available or in primary-only state.
      • 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.
      See Also:

    • modifyCacheParameterGroup

      default CompletableFuture<ModifyCacheParameterGroupResponse> modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest)

      Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.


      This is a convenience which creates an instance of the ModifyCacheParameterGroupRequest.Builder avoiding the need to create one manually via ModifyCacheParameterGroupRequest.builder()

      Parameters:
      modifyCacheParameterGroupRequest - A Consumer that will call methods on ModifyCacheParameterGroupRequest.Builder to create a request. Represents the input of a ModifyCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the ModifyCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 available or in primary-only state.
      • 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.
      See Also:

    • modifyCacheSubnetGroup

      default CompletableFuture<ModifyCacheSubnetGroupResponse> modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest)

      Modifies an existing cache subnet group.

      Parameters:
      modifyCacheSubnetGroupRequest - Represents the input of a ModifyCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the ModifyCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SubnetNotAllowedException At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
      • 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.
      See Also:

    • modifyCacheSubnetGroup

      default CompletableFuture<ModifyCacheSubnetGroupResponse> modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest)

      Modifies an existing cache subnet group.


      This is a convenience which creates an instance of the ModifyCacheSubnetGroupRequest.Builder avoiding the need to create one manually via ModifyCacheSubnetGroupRequest.builder()

      Parameters:
      modifyCacheSubnetGroupRequest - A Consumer that will call methods on ModifyCacheSubnetGroupRequest.Builder to create a request. Represents the input of a ModifyCacheSubnetGroup operation.
      Returns:
      A Java Future containing the result of the ModifyCacheSubnetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SubnetNotAllowedException At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
      • 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.
      See Also:

    • modifyGlobalReplicationGroup

      default CompletableFuture<ModifyGlobalReplicationGroupResponse> modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest)

      Modifies the settings for a Global datastore.

      Parameters:
      modifyGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the ModifyGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • modifyGlobalReplicationGroup

      default CompletableFuture<ModifyGlobalReplicationGroupResponse> modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest)

      Modifies the settings for a Global datastore.


      This is a convenience which creates an instance of the ModifyGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via ModifyGlobalReplicationGroupRequest.builder()

      Parameters:
      modifyGlobalReplicationGroupRequest - A Consumer that will call methods on ModifyGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • modifyReplicationGroup

      default CompletableFuture<ModifyReplicationGroupResponse> modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest)

      Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

      This operation is valid for Valkey or Redis OSS only.

      Parameters:
      modifyReplicationGroupRequest - Represents the input of a ModifyReplicationGroups operation.
      Returns:
      A Java Future containing the result of the ModifyReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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.
      See Also:

    • modifyReplicationGroup

      default CompletableFuture<ModifyReplicationGroupResponse> modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest)

      Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

      This operation is valid for Valkey or Redis OSS only.


      This is a convenience which creates an instance of the ModifyReplicationGroupRequest.Builder avoiding the need to create one manually via ModifyReplicationGroupRequest.builder()

      Parameters:
      modifyReplicationGroupRequest - A Consumer that will call methods on ModifyReplicationGroupRequest.Builder to create a request. Represents the input of a ModifyReplicationGroups operation.
      Returns:
      A Java Future containing the result of the ModifyReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • 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.
      See Also:

    • modifyReplicationGroupShardConfiguration

      default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest)

      Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

      Parameters:
      modifyReplicationGroupShardConfigurationRequest - Represents the input for a ModifyReplicationGroupShardConfiguration operation.
      Returns:
      A Java Future containing the result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • modifyReplicationGroupShardConfiguration

      default CompletableFuture<ModifyReplicationGroupShardConfigurationResponse> modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest)

      Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.


      This is a convenience which creates an instance of the ModifyReplicationGroupShardConfigurationRequest.Builder avoiding the need to create one manually via ModifyReplicationGroupShardConfigurationRequest.builder()

      Parameters:
      modifyReplicationGroupShardConfigurationRequest - A Consumer that will call methods on ModifyReplicationGroupShardConfigurationRequest.Builder to create a request. Represents the input for a ModifyReplicationGroupShardConfiguration operation.
      Returns:
      A Java Future containing the result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 90
      • NodeQuotaForCustomerExceededException 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.
      See Also:

    • modifyServerlessCache

      default CompletableFuture<ModifyServerlessCacheResponse> modifyServerlessCache(ModifyServerlessCacheRequest modifyServerlessCacheRequest)

      This API modifies the attributes of a serverless cache.

      Parameters:
      modifyServerlessCacheRequest -
      Returns:
      A Java Future containing the result of the ModifyServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • modifyServerlessCache

      default CompletableFuture<ModifyServerlessCacheResponse> modifyServerlessCache(Consumer<ModifyServerlessCacheRequest.Builder> modifyServerlessCacheRequest)

      This API modifies the attributes of a serverless cache.


      This is a convenience which creates an instance of the ModifyServerlessCacheRequest.Builder avoiding the need to create one manually via ModifyServerlessCacheRequest.builder()

      Parameters:
      modifyServerlessCacheRequest - A Consumer that will call methods on ModifyServerlessCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyServerlessCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • InvalidParameterValueException The value for a parameter is invalid.
      • InvalidParameterCombinationException Two or more incompatible parameters were specified.
      • InvalidCredentialsException You must enter valid credentials.
      • InvalidUserGroupStateException The user group is not in an active state.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • 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.
      See Also:

    • modifyUser

      default CompletableFuture<ModifyUserResponse> modifyUser(ModifyUserRequest modifyUserRequest)

      Changes user password(s) and/or access string.

      Parameters:
      modifyUserRequest -
      Returns:
      A Java Future containing the result of the ModifyUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • InvalidUserStateException The user is not in active state.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) 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.
      See Also:

    • modifyUser

      default CompletableFuture<ModifyUserResponse> modifyUser(Consumer<ModifyUserRequest.Builder> modifyUserRequest)

      Changes user password(s) and/or access string.


      This is a convenience which creates an instance of the ModifyUserRequest.Builder avoiding the need to create one manually via ModifyUserRequest.builder()

      Parameters:
      modifyUserRequest - A Consumer that will call methods on ModifyUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyUser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserNotFoundException The user does not exist or could not be found.
      • InvalidUserStateException The user is not in active state.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) 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.
      See Also:

    • modifyUserGroup

      default CompletableFuture<ModifyUserGroupResponse> modifyUserGroup(ModifyUserGroupRequest modifyUserGroupRequest)

      Changes the list of users that belong to the user group.

      Parameters:
      modifyUserGroupRequest -
      Returns:
      A Java Future containing the result of the ModifyUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • UserNotFoundException The user does not exist or could not be found.
      • DuplicateUserNameException A user with this username already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • DefaultUserRequiredException You must add default user to a user group.
      • InvalidUserGroupStateException The user group is not in an active 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.
      See Also:

    • modifyUserGroup

      default CompletableFuture<ModifyUserGroupResponse> modifyUserGroup(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest)

      Changes the list of users that belong to the user group.


      This is a convenience which creates an instance of the ModifyUserGroupRequest.Builder avoiding the need to create one manually via ModifyUserGroupRequest.builder()

      Parameters:
      modifyUserGroupRequest - A Consumer that will call methods on ModifyUserGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ModifyUserGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • UserGroupNotFoundException The user group was not found or does not exist
      • UserNotFoundException The user does not exist or could not be found.
      • DuplicateUserNameException A user with this username already exists.
      • ServiceLinkedRoleNotFoundException The specified service linked role (SLR) was not found.
      • DefaultUserRequiredException You must add default user to a user group.
      • InvalidUserGroupStateException The user group is not in an active 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.
      See Also:

    • purchaseReservedCacheNodesOffering

      default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest)

      Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.

      Parameters:
      purchaseReservedCacheNodesOfferingRequest - Represents the input of a PurchaseReservedCacheNodesOffering operation.
      Returns:
      A Java Future containing the result of the PurchaseReservedCacheNodesOffering operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • purchaseReservedCacheNodesOffering

      default CompletableFuture<PurchaseReservedCacheNodesOfferingResponse> purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest)

      Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.


      This is a convenience which creates an instance of the PurchaseReservedCacheNodesOfferingRequest.Builder avoiding the need to create one manually via PurchaseReservedCacheNodesOfferingRequest.builder()

      Parameters:
      purchaseReservedCacheNodesOfferingRequest - A Consumer that will call methods on PurchaseReservedCacheNodesOfferingRequest.Builder to create a request. Represents the input of a PurchaseReservedCacheNodesOffering operation.
      Returns:
      A Java Future containing the result of the PurchaseReservedCacheNodesOffering operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      See Also:

    • rebalanceSlotsInGlobalReplicationGroup

      default CompletableFuture<RebalanceSlotsInGlobalReplicationGroupResponse> rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest)

      Redistribute slots to ensure uniform distribution across existing shards in the cluster.

      Parameters:
      rebalanceSlotsInGlobalReplicationGroupRequest -
      Returns:
      A Java Future containing the result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • rebalanceSlotsInGlobalReplicationGroup

      default CompletableFuture<RebalanceSlotsInGlobalReplicationGroupResponse> rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest)

      Redistribute slots to ensure uniform distribution across existing shards in the cluster.


      This is a convenience which creates an instance of the RebalanceSlotsInGlobalReplicationGroupRequest.Builder avoiding the need to create one manually via RebalanceSlotsInGlobalReplicationGroupRequest.builder()

      Parameters:
      rebalanceSlotsInGlobalReplicationGroupRequest - A Consumer that will call methods on RebalanceSlotsInGlobalReplicationGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • GlobalReplicationGroupNotFoundException The Global datastore does not exist
      • InvalidGlobalReplicationGroupStateException The Global datastore is not available or in primary-only state.
      • 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.
      See Also:

    • rebootCacheCluster

      default CompletableFuture<RebootCacheClusterResponse> rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest)

      Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

      The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

      When the reboot is complete, a cluster event is created.

      Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.

      If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

      Parameters:
      rebootCacheClusterRequest - Represents the input of a RebootCacheCluster operation.
      Returns:
      A Java Future containing the result of the RebootCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • rebootCacheCluster

      default CompletableFuture<RebootCacheClusterResponse> rebootCacheCluster(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest)

      Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

      The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

      When the reboot is complete, a cluster event is created.

      Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.

      If you make changes to parameters that require a Valkey or Redis OSS (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()

      Parameters:
      rebootCacheClusterRequest - A Consumer that will call methods on RebootCacheClusterRequest.Builder to create a request. Represents the input of a RebootCacheCluster operation.
      Returns:
      A Java Future containing the result of the RebootCacheCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

      Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

      Parameters:
      removeTagsFromResourceRequest - Represents the input of a RemoveTagsFromResource operation.
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • removeTagsFromResource

      default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)

      Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.


      This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the need to create one manually via RemoveTagsFromResourceRequest.builder()

      Parameters:
      removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request. Represents the input of a RemoveTagsFromResource operation.
      Returns:
      A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
      • CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
      • 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.
      • InvalidReplicationGroupStateException The requested replication group is not in the available state.
      • ReplicationGroupNotFoundException The specified replication group does not exist.
      • ReservedCacheNodeNotFoundException The requested reserved cache node was not found.
      • SnapshotNotFoundException The requested snapshot name does not refer to an existing snapshot.
      • UserNotFoundException The user does not exist or could not be found.
      • UserGroupNotFoundException The user group was not found or does not exist
      • ServerlessCacheNotFoundException The serverless cache was not found or does not exist.
      • InvalidServerlessCacheStateException The account for these credentials is not currently active.
      • ServerlessCacheSnapshotNotFoundException This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
      • InvalidServerlessCacheSnapshotStateException The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
      • 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.
      See Also:

    • resetCacheParameterGroup

      default CompletableFuture<ResetCacheParameterGroupResponse> resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest)

      Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

      Parameters:
      resetCacheParameterGroupRequest - Represents the input of a ResetCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the ResetCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 available or in primary-only state.
      • 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.
      See Also:

    • resetCacheParameterGroup

      default CompletableFuture<ResetCacheParameterGroupResponse> resetCacheParameterGroup(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest)

      Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.


      This is a convenience which creates an instance of the ResetCacheParameterGroupRequest.Builder avoiding the need to create one manually via ResetCacheParameterGroupRequest.builder()

      Parameters:
      resetCacheParameterGroupRequest - A Consumer that will call methods on ResetCacheParameterGroupRequest.Builder to create a request. Represents the input of a ResetCacheParameterGroup operation.
      Returns:
      A Java Future containing the result of the ResetCacheParameterGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 available or in primary-only state.
      • 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.
      See Also:

    • revokeCacheSecurityGroupIngress

      default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest)

      Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

      Parameters:
      revokeCacheSecurityGroupIngressRequest - Represents the input of a RevokeCacheSecurityGroupIngress operation.
      Returns:
      A Java Future containing the result of the RevokeCacheSecurityGroupIngress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • revokeCacheSecurityGroupIngress

      default CompletableFuture<RevokeCacheSecurityGroupIngressResponse> revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest)

      Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.


      This is a convenience which creates an instance of the RevokeCacheSecurityGroupIngressRequest.Builder avoiding the need to create one manually via RevokeCacheSecurityGroupIngressRequest.builder()

      Parameters:
      revokeCacheSecurityGroupIngressRequest - A Consumer that will call methods on RevokeCacheSecurityGroupIngressRequest.Builder to create a request. Represents the input of a RevokeCacheSecurityGroupIngress operation.
      Returns:
      A Java Future containing the result of the RevokeCacheSecurityGroupIngress operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startMigration

      default CompletableFuture<StartMigrationResponse> startMigration(StartMigrationRequest startMigrationRequest)

      Start the migration of data.

      Parameters:
      startMigrationRequest -
      Returns:
      A Java Future containing the result of the StartMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startMigration

      default CompletableFuture<StartMigrationResponse> startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest)

      Start the migration of data.


      This is a convenience which creates an instance of the StartMigrationRequest.Builder avoiding the need to create one manually via StartMigrationRequest.builder()

      Parameters:
      startMigrationRequest - A Consumer that will call methods on StartMigrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testFailover

      default CompletableFuture<TestFailoverResponse> testFailover(TestFailoverRequest testFailoverRequest)

      Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

      This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

      Note the following

      • A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.

      • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

      • If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

      • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

        1. Replication group message: Test Failover API called for node group <node-group-id>

        2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed

        3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed

        4. Cache cluster message: Recovering cache nodes <node-id>

        5. Cache cluster message: Finished recovery for cache nodes <node-id>

        For more information see:

      Also see, Testing Multi-AZ in the ElastiCache User Guide.

      Parameters:
      testFailoverRequest -
      Returns:
      A Java Future containing the result of the TestFailover operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testFailover

      default CompletableFuture<TestFailoverResponse> testFailover(Consumer<TestFailoverRequest.Builder> testFailoverRequest)

      Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

      This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

      Note the following

      • A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.

      • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

      • If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

      • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

        1. Replication group message: Test Failover API called for node group <node-group-id>

        2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed

        3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed

        4. Cache cluster message: Recovering cache nodes <node-id>

        5. Cache cluster message: Finished recovery for cache nodes <node-id>

        For more information see:

      Also see, Testing Multi-AZ in the ElastiCache User Guide.


      This is a convenience which creates an instance of the TestFailoverRequest.Builder avoiding the need to create one manually via TestFailoverRequest.builder()

      Parameters:
      testFailoverRequest - A Consumer that will call methods on TestFailoverRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestFailover operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testMigration

      default CompletableFuture<TestMigrationResponse> testMigration(TestMigrationRequest testMigrationRequest)

      Async API to test connection between source and target replication group.

      Parameters:
      testMigrationRequest -
      Returns:
      A Java Future containing the result of the TestMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • testMigration

      default CompletableFuture<TestMigrationResponse> testMigration(Consumer<TestMigrationRequest.Builder> testMigrationRequest)

      Async API to test connection between source and target replication group.


      This is a convenience which creates an instance of the TestMigrationRequest.Builder avoiding the need to create one manually via TestMigrationRequest.builder()

      Parameters:
      testMigrationRequest - A Consumer that will call methods on TestMigrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestMigration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • waiter

      default ElastiCacheAsyncWaiter waiter()
      Create an instance of ElastiCacheAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of ElastiCacheAsyncWaiter

    • serviceClientConfiguration

      default ElastiCacheServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ElastiCacheAsyncClient create()
      Create a ElastiCacheAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ElastiCacheAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ElastiCacheAsyncClient.