Interface ElastiCacheClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface ElastiCacheClient extends AwsClient
Service client for accessing Amazon ElastiCache. This can be created using the staticbuilder()method.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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
- Parameters:
addTagsToResourceRequest- Represents the input of an AddTagsToResource operation.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, TagQuotaPerResourceExceededException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builderavoiding the need to create one manually viaAddTagsToResourceRequest.builder()- Parameters:
addTagsToResourceRequest- AConsumerthat will call methods onAddTagsToResourceRequest.Builderto create a request. Represents the input of an AddTagsToResource operation.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
authorizeCacheSecurityGroupIngress
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest authorizeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException, AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
- Parameters:
authorizeCacheSecurityGroupIngressRequest- Represents the input of an AuthorizeCacheSecurityGroupIngress operation.- Returns:
- Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
authorizeCacheSecurityGroupIngress
default AuthorizeCacheSecurityGroupIngressResponse authorizeCacheSecurityGroupIngress(Consumer<AuthorizeCacheSecurityGroupIngressRequest.Builder> authorizeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, InvalidCacheSecurityGroupStateException, AuthorizationAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
This is a convenience which creates an instance of the
AuthorizeCacheSecurityGroupIngressRequest.Builderavoiding the need to create one manually viaAuthorizeCacheSecurityGroupIngressRequest.builder()- Parameters:
authorizeCacheSecurityGroupIngressRequest- AConsumerthat will call methods onAuthorizeCacheSecurityGroupIngressRequest.Builderto create a request. Represents the input of an AuthorizeCacheSecurityGroupIngress operation.- Returns:
- Result of the AuthorizeCacheSecurityGroupIngress operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchApplyUpdateAction
default BatchApplyUpdateActionResponse batchApplyUpdateAction(BatchApplyUpdateActionRequest batchApplyUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
- Parameters:
batchApplyUpdateActionRequest-- Returns:
- Result of the BatchApplyUpdateAction operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchApplyUpdateAction
default BatchApplyUpdateActionResponse batchApplyUpdateAction(Consumer<BatchApplyUpdateActionRequest.Builder> batchApplyUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
This is a convenience which creates an instance of the
BatchApplyUpdateActionRequest.Builderavoiding the need to create one manually viaBatchApplyUpdateActionRequest.builder()- Parameters:
batchApplyUpdateActionRequest- AConsumerthat will call methods onBatchApplyUpdateActionRequest.Builderto create a request.- Returns:
- Result of the BatchApplyUpdateAction operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchStopUpdateAction
default BatchStopUpdateActionResponse batchStopUpdateAction(BatchStopUpdateActionRequest batchStopUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
- Parameters:
batchStopUpdateActionRequest-- Returns:
- Result of the BatchStopUpdateAction operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchStopUpdateAction
default BatchStopUpdateActionResponse batchStopUpdateAction(Consumer<BatchStopUpdateActionRequest.Builder> batchStopUpdateActionRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
This is a convenience which creates an instance of the
BatchStopUpdateActionRequest.Builderavoiding the need to create one manually viaBatchStopUpdateActionRequest.builder()- Parameters:
batchStopUpdateActionRequest- AConsumerthat will call methods onBatchStopUpdateActionRequest.Builderto create a request.- Returns:
- Result of the BatchStopUpdateAction operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeMigration
default CompleteMigrationResponse completeMigration(CompleteMigrationRequest completeMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException
Complete the migration of data.
- Parameters:
completeMigrationRequest-- Returns:
- Result of the CompleteMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
completeMigration
default CompleteMigrationResponse completeMigration(Consumer<CompleteMigrationRequest.Builder> completeMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotUnderMigrationException, AwsServiceException, SdkClientException, ElastiCacheException
Complete the migration of data.
This is a convenience which creates an instance of the
CompleteMigrationRequest.Builderavoiding the need to create one manually viaCompleteMigrationRequest.builder()- Parameters:
completeMigrationRequest- AConsumerthat will call methods onCompleteMigrationRequest.Builderto create a request.- Returns:
- Result of the CompleteMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
copyServerlessCacheSnapshot
default CopyServerlessCacheSnapshotResponse copyServerlessCacheSnapshot(CopyServerlessCacheSnapshotRequest copyServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheSnapshotNotFoundException, ServerlessCacheSnapshotQuotaExceededException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
copyServerlessCacheSnapshotRequest-- Returns:
- Result of the CopyServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
copyServerlessCacheSnapshot
default CopyServerlessCacheSnapshotResponse copyServerlessCacheSnapshot(Consumer<CopyServerlessCacheSnapshotRequest.Builder> copyServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheSnapshotNotFoundException, ServerlessCacheSnapshotQuotaExceededException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
This is a convenience which creates an instance of the
CopyServerlessCacheSnapshotRequest.Builderavoiding the need to create one manually viaCopyServerlessCacheSnapshotRequest.builder()- Parameters:
copyServerlessCacheSnapshotRequest- AConsumerthat will call methods onCopyServerlessCacheSnapshotRequest.Builderto create a request.- Returns:
- Result of the CopyServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
copySnapshot
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Makes a copy of an existing snapshot.
This operation is valid for Valkey or Redis OSS only.
Users or groups that have permissions to use the
CopySnapshotoperation 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 theCopySnapshotoperation. 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
TargetSnapshotNamea new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value forTargetSnapshotName. -
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
-
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
-
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
- Parameters:
copySnapshotRequest- Represents the input of aCopySnapshotMessageoperation.- Returns:
- Result of the CopySnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
copySnapshot
default CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws SnapshotAlreadyExistsException, SnapshotNotFoundException, SnapshotQuotaExceededException, InvalidSnapshotStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Makes a copy of an existing snapshot.
This operation is valid for Valkey or Redis OSS only.
Users or groups that have permissions to use the
CopySnapshotoperation 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 theCopySnapshotoperation. 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
TargetSnapshotNamea new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value forTargetSnapshotName. -
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
-
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
-
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
This is a convenience which creates an instance of the
CopySnapshotRequest.Builderavoiding the need to create one manually viaCopySnapshotRequest.builder()- Parameters:
copySnapshotRequest- AConsumerthat will call methods onCopySnapshotRequest.Builderto create a request. Represents the input of aCopySnapshotMessageoperation.- Returns:
- Result of the CopySnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createCacheCluster
default CreateCacheClusterResponse createCacheCluster(CreateCacheClusterRequest createCacheClusterRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, 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:
- Result of the CreateCacheCluster operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
createCacheCluster
default CreateCacheClusterResponse createCacheCluster(Consumer<CreateCacheClusterRequest.Builder> createCacheClusterRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, CacheClusterAlreadyExistsException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, 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.Builderavoiding the need to create one manually viaCreateCacheClusterRequest.builder()- Parameters:
createCacheClusterRequest- AConsumerthat will call methods onCreateCacheClusterRequest.Builderto create a request. Represents the input of a CreateCacheCluster operation.- Returns:
- Result of the CreateCacheCluster operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
createCacheParameterGroup
default CreateCacheParameterGroupResponse createCacheParameterGroup(CreateCacheParameterGroupRequest createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
-
ModifyCacheParameterGroup in the ElastiCache API Reference.
-
Parameters and Parameter Groups in the ElastiCache User Guide.
- Parameters:
createCacheParameterGroupRequest- Represents the input of aCreateCacheParameterGroupoperation.- Returns:
- Result of the CreateCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createCacheParameterGroup
default CreateCacheParameterGroupResponse createCacheParameterGroup(Consumer<CreateCacheParameterGroupRequest.Builder> createCacheParameterGroupRequest) throws CacheParameterGroupQuotaExceededException, CacheParameterGroupAlreadyExistsException, InvalidCacheParameterGroupStateException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
-
ModifyCacheParameterGroup in the ElastiCache API Reference.
-
Parameters and Parameter Groups in the ElastiCache User Guide.
This is a convenience which creates an instance of the
CreateCacheParameterGroupRequest.Builderavoiding the need to create one manually viaCreateCacheParameterGroupRequest.builder()- Parameters:
createCacheParameterGroupRequest- AConsumerthat will call methods onCreateCacheParameterGroupRequest.Builderto create a request. Represents the input of aCreateCacheParameterGroupoperation.- Returns:
- Result of the CreateCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createCacheSecurityGroup
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(CreateCacheSecurityGroupRequest createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
- Parameters:
createCacheSecurityGroupRequest- Represents the input of aCreateCacheSecurityGroupoperation.- Returns:
- Result of the CreateCacheSecurityGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createCacheSecurityGroup
default CreateCacheSecurityGroupResponse createCacheSecurityGroup(Consumer<CreateCacheSecurityGroupRequest.Builder> createCacheSecurityGroupRequest) throws CacheSecurityGroupAlreadyExistsException, CacheSecurityGroupQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
This is a convenience which creates an instance of the
CreateCacheSecurityGroupRequest.Builderavoiding the need to create one manually viaCreateCacheSecurityGroupRequest.builder()- Parameters:
createCacheSecurityGroupRequest- AConsumerthat will call methods onCreateCacheSecurityGroupRequest.Builderto create a request. Represents the input of aCreateCacheSecurityGroupoperation.- Returns:
- Result of the CreateCacheSecurityGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createCacheSubnetGroup
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(CreateCacheSubnetGroupRequest createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, TagQuotaPerResourceExceededException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
- Parameters:
createCacheSubnetGroupRequest- Represents the input of aCreateCacheSubnetGroupoperation.- Returns:
- Result of the CreateCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createCacheSubnetGroup
default CreateCacheSubnetGroupResponse createCacheSubnetGroup(Consumer<CreateCacheSubnetGroupRequest.Builder> createCacheSubnetGroupRequest) throws CacheSubnetGroupAlreadyExistsException, CacheSubnetGroupQuotaExceededException, CacheSubnetQuotaExceededException, TagQuotaPerResourceExceededException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
This is a convenience which creates an instance of the
CreateCacheSubnetGroupRequest.Builderavoiding the need to create one manually viaCreateCacheSubnetGroupRequest.builder()- Parameters:
createCacheSubnetGroupRequest- AConsumerthat will call methods onCreateCacheSubnetGroupRequest.Builderto create a request. Represents the input of aCreateCacheSubnetGroupoperation.- Returns:
- Result of the CreateCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createGlobalReplicationGroup
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(CreateGlobalReplicationGroupRequest createGlobalReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, GlobalReplicationGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
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:
- Result of the CreateGlobalReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createGlobalReplicationGroup
default CreateGlobalReplicationGroupResponse createGlobalReplicationGroup(Consumer<CreateGlobalReplicationGroupRequest.Builder> createGlobalReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, GlobalReplicationGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
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.Builderavoiding the need to create one manually viaCreateGlobalReplicationGroupRequest.builder()- Parameters:
createGlobalReplicationGroupRequest- AConsumerthat will call methods onCreateGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the CreateGlobalReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createReplicationGroup
default CreateReplicationGroupResponse createReplicationGroup(CreateReplicationGroupRequest createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InvalidUserGroupStateException, UserGroupNotFoundException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a 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 aCreateReplicationGroupoperation.- Returns:
- Result of the CreateReplicationGroup operation returned by the service.
- Throws:
CacheClusterNotFoundException- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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 existInsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException- The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException- The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException- The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException- The VPC network is in an invalid state.TagQuotaPerResourceExceededException- The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- The Global datastore is not 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.AwsServiceException- See Also:
- AWS API Documentation
-
createReplicationGroup
default CreateReplicationGroupResponse createReplicationGroup(Consumer<CreateReplicationGroupRequest.Builder> createReplicationGroupRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, ReplicationGroupAlreadyExistsException, InvalidUserGroupStateException, UserGroupNotFoundException, InsufficientCacheClusterCapacityException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, ClusterQuotaForCustomerExceededException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, TagQuotaPerResourceExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a 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.Builderavoiding the need to create one manually viaCreateReplicationGroupRequest.builder()- Parameters:
createReplicationGroupRequest- AConsumerthat will call methods onCreateReplicationGroupRequest.Builderto create a request. Represents the input of aCreateReplicationGroupoperation.- Returns:
- Result of the CreateReplicationGroup operation returned by the service.
- Throws:
CacheClusterNotFoundException- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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 existInsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.CacheSecurityGroupNotFoundException- The requested cache security group name does not refer to an existing cache security group.CacheSubnetGroupNotFoundException- The requested cache subnet group name does not refer to an existing cache subnet group.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeQuotaForClusterExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.CacheParameterGroupNotFoundException- The requested cache parameter group name does not refer to an existing cache parameter group.InvalidVpcNetworkStateException- The VPC network is in an invalid state.TagQuotaPerResourceExceededException- The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- The Global datastore is not 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.AwsServiceException- See Also:
- AWS API Documentation
-
createServerlessCache
default CreateServerlessCacheResponse createServerlessCache(CreateServerlessCacheRequest createServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheAlreadyExistsException, ServerlessCacheQuotaForCustomerExceededException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a serverless cache.
- Parameters:
createServerlessCacheRequest-- Returns:
- Result of the CreateServerlessCache operation returned by the service.
- Throws:
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 existTagQuotaPerResourceExceededException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
createServerlessCache
default CreateServerlessCacheResponse createServerlessCache(Consumer<CreateServerlessCacheRequest.Builder> createServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheAlreadyExistsException, ServerlessCacheQuotaForCustomerExceededException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, TagQuotaPerResourceExceededException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a serverless cache.
This is a convenience which creates an instance of the
CreateServerlessCacheRequest.Builderavoiding the need to create one manually viaCreateServerlessCacheRequest.builder()- Parameters:
createServerlessCacheRequest- AConsumerthat will call methods onCreateServerlessCacheRequest.Builderto create a request.- Returns:
- Result of the CreateServerlessCache operation returned by the service.
- Throws:
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 existTagQuotaPerResourceExceededException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
createServerlessCacheSnapshot
default CreateServerlessCacheSnapshotResponse createServerlessCacheSnapshot(CreateServerlessCacheSnapshotRequest createServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotQuotaExceededException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
createServerlessCacheSnapshotRequest-- Returns:
- Result of the CreateServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createServerlessCacheSnapshot
default CreateServerlessCacheSnapshotResponse createServerlessCacheSnapshot(Consumer<CreateServerlessCacheSnapshotRequest.Builder> createServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotAlreadyExistsException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotQuotaExceededException, ServiceLinkedRoleNotFoundException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
This is a convenience which creates an instance of the
CreateServerlessCacheSnapshotRequest.Builderavoiding the need to create one manually viaCreateServerlessCacheSnapshotRequest.builder()- Parameters:
createServerlessCacheSnapshotRequest- AConsumerthat will call methods onCreateServerlessCacheSnapshotRequest.Builderto create a request.- Returns:
- Result of the CreateServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createSnapshot
default CreateSnapshotResponse createSnapshot(CreateSnapshotRequest createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, TagQuotaPerResourceExceededException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Valkey or Redis OSS only.
- Parameters:
createSnapshotRequest- Represents the input of aCreateSnapshotoperation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- Throws:
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 theavailablestate.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
createSnapshot
default CreateSnapshotResponse createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) throws SnapshotAlreadyExistsException, CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, SnapshotQuotaExceededException, SnapshotFeatureNotSupportedException, TagQuotaPerResourceExceededException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Valkey or Redis OSS only.
This is a convenience which creates an instance of the
CreateSnapshotRequest.Builderavoiding the need to create one manually viaCreateSnapshotRequest.builder()- Parameters:
createSnapshotRequest- AConsumerthat will call methods onCreateSnapshotRequest.Builderto create a request. Represents the input of aCreateSnapshotoperation.- Returns:
- Result of the CreateSnapshot operation returned by the service.
- Throws:
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 theavailablestate.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws UserAlreadyExistsException, UserQuotaExceededException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException
For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control (RBAC).
- Parameters:
createUserRequest-- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws UserAlreadyExistsException, UserQuotaExceededException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException
For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control (RBAC).
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserGroup
default CreateUserGroupResponse createUserGroup(CreateUserGroupRequest createUserGroupRequest) throws UserNotFoundException, DuplicateUserNameException, UserGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, UserGroupQuotaExceededException, InvalidParameterValueException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException
For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see Using Role Based Access Control (RBAC)
- Parameters:
createUserGroupRequest-- Returns:
- Result of the CreateUserGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createUserGroup
default CreateUserGroupResponse createUserGroup(Consumer<CreateUserGroupRequest.Builder> createUserGroupRequest) throws UserNotFoundException, DuplicateUserNameException, UserGroupAlreadyExistsException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, UserGroupQuotaExceededException, InvalidParameterValueException, TagQuotaPerResourceExceededException, AwsServiceException, SdkClientException, ElastiCacheException
For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: 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.Builderavoiding the need to create one manually viaCreateUserGroupRequest.builder()- Parameters:
createUserGroupRequest- AConsumerthat will call methods onCreateUserGroupRequest.Builderto create a request.- Returns:
- Result of the CreateUserGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
decreaseNodeGroupsInGlobalReplicationGroup
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest decreaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Decreases the number of node groups in a Global datastore
- Parameters:
decreaseNodeGroupsInGlobalReplicationGroupRequest-- Returns:
- Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
decreaseNodeGroupsInGlobalReplicationGroup
default DecreaseNodeGroupsInGlobalReplicationGroupResponse decreaseNodeGroupsInGlobalReplicationGroup(Consumer<DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> decreaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Decreases the number of node groups in a Global datastore
This is a convenience which creates an instance of the
DecreaseNodeGroupsInGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaDecreaseNodeGroupsInGlobalReplicationGroupRequest.builder()- Parameters:
decreaseNodeGroupsInGlobalReplicationGroupRequest- AConsumerthat will call methods onDecreaseNodeGroupsInGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the DecreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
decreaseReplicaCount
default DecreaseReplicaCountResponse decreaseReplicaCount(DecreaseReplicaCountRequest decreaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Dynamically decreases the number of replicas in a 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:
- Result of the DecreaseReplicaCount operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.ServiceLinkedRoleNotFoundException- The specified service linked role (SLR) was not found.NoOperationException- The operation was not performed because no changes were required.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
decreaseReplicaCount
default DecreaseReplicaCountResponse decreaseReplicaCount(Consumer<DecreaseReplicaCountRequest.Builder> decreaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, ServiceLinkedRoleNotFoundException, NoOperationException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Dynamically decreases the number of replicas in a 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.Builderavoiding the need to create one manually viaDecreaseReplicaCountRequest.builder()- Parameters:
decreaseReplicaCountRequest- AConsumerthat will call methods onDecreaseReplicaCountRequest.Builderto create a request.- Returns:
- Result of the DecreaseReplicaCount operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.ServiceLinkedRoleNotFoundException- The specified service linked role (SLR) was not found.NoOperationException- The operation was not performed because no changes were required.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheCluster
default DeleteCacheClusterResponse deleteCacheCluster(DeleteCacheClusterRequest deleteCacheClusterRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a previously provisioned cluster.
DeleteCacheClusterdeletes 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
availablestate
- Parameters:
deleteCacheClusterRequest- Represents the input of aDeleteCacheClusteroperation.- Returns:
- Result of the DeleteCacheCluster operation returned by the service.
- Throws:
CacheClusterNotFoundException- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteCacheCluster
default DeleteCacheClusterResponse deleteCacheCluster(Consumer<DeleteCacheClusterRequest.Builder> deleteCacheClusterRequest) throws CacheClusterNotFoundException, InvalidCacheClusterStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a previously provisioned cluster.
DeleteCacheClusterdeletes 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
availablestate
This is a convenience which creates an instance of the
DeleteCacheClusterRequest.Builderavoiding the need to create one manually viaDeleteCacheClusterRequest.builder()- Parameters:
deleteCacheClusterRequest- AConsumerthat will call methods onDeleteCacheClusterRequest.Builderto create a request. Represents the input of aDeleteCacheClusteroperation.- Returns:
- Result of the DeleteCacheCluster operation returned by the service.
- Throws:
CacheClusterNotFoundException- The requested cluster ID does not refer to an existing cluster.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteCacheParameterGroup
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(DeleteCacheParameterGroupRequest deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
- Parameters:
deleteCacheParameterGroupRequest- Represents the input of aDeleteCacheParameterGroupoperation.- Returns:
- Result of the DeleteCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheParameterGroup
default DeleteCacheParameterGroupResponse deleteCacheParameterGroup(Consumer<DeleteCacheParameterGroupRequest.Builder> deleteCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
This is a convenience which creates an instance of the
DeleteCacheParameterGroupRequest.Builderavoiding the need to create one manually viaDeleteCacheParameterGroupRequest.builder()- Parameters:
deleteCacheParameterGroupRequest- AConsumerthat will call methods onDeleteCacheParameterGroupRequest.Builderto create a request. Represents the input of aDeleteCacheParameterGroupoperation.- Returns:
- Result of the DeleteCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheSecurityGroup
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
- Parameters:
deleteCacheSecurityGroupRequest- Represents the input of aDeleteCacheSecurityGroupoperation.- Returns:
- Result of the DeleteCacheSecurityGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheSecurityGroup
default DeleteCacheSecurityGroupResponse deleteCacheSecurityGroup(Consumer<DeleteCacheSecurityGroupRequest.Builder> deleteCacheSecurityGroupRequest) throws InvalidCacheSecurityGroupStateException, CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
This is a convenience which creates an instance of the
DeleteCacheSecurityGroupRequest.Builderavoiding the need to create one manually viaDeleteCacheSecurityGroupRequest.builder()- Parameters:
deleteCacheSecurityGroupRequest- AConsumerthat will call methods onDeleteCacheSecurityGroupRequest.Builderto create a request. Represents the input of aDeleteCacheSecurityGroupoperation.- Returns:
- Result of the DeleteCacheSecurityGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheSubnetGroup
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
- Parameters:
deleteCacheSubnetGroupRequest- Represents the input of aDeleteCacheSubnetGroupoperation.- Returns:
- Result of the DeleteCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCacheSubnetGroup
default DeleteCacheSubnetGroupResponse deleteCacheSubnetGroup(Consumer<DeleteCacheSubnetGroupRequest.Builder> deleteCacheSubnetGroupRequest) throws CacheSubnetGroupInUseException, CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
This is a convenience which creates an instance of the
DeleteCacheSubnetGroupRequest.Builderavoiding the need to create one manually viaDeleteCacheSubnetGroupRequest.builder()- Parameters:
deleteCacheSubnetGroupRequest- AConsumerthat will call methods onDeleteCacheSubnetGroupRequest.Builderto create a request. Represents the input of aDeleteCacheSubnetGroupoperation.- Returns:
- Result of the DeleteCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGlobalReplicationGroup
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest deleteGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Deleting a Global datastore is a two-step process:
-
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
-
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroupAPI to delete the Global datastore while retainining the primary cluster usingRetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting
RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
- Parameters:
deleteGlobalReplicationGroupRequest-- Returns:
- Result of the DeleteGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteGlobalReplicationGroup
default DeleteGlobalReplicationGroupResponse deleteGlobalReplicationGroup(Consumer<DeleteGlobalReplicationGroupRequest.Builder> deleteGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Deleting a Global datastore is a two-step process:
-
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
-
Once the Global datastore contains only the primary cluster, you can use the
DeleteGlobalReplicationGroupAPI to delete the Global datastore while retainining the primary cluster usingRetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting
RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This is a convenience which creates an instance of the
DeleteGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaDeleteGlobalReplicationGroupRequest.builder()- Parameters:
deleteGlobalReplicationGroupRequest- AConsumerthat will call methods onDeleteGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteReplicationGroup
default DeleteReplicationGroupResponse deleteReplicationGroup(DeleteReplicationGroupRequest deleteReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting
RetainPrimaryCluster=true.When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
-
CreateSnapshotpermission is required to create a final snapshot. Without this permission, the API call will fail with anAccess Deniedexception. -
This operation is valid for Redis OSS only.
- Parameters:
deleteReplicationGroupRequest- Represents the input of aDeleteReplicationGroupoperation.- Returns:
- Result of the DeleteReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteReplicationGroup
default DeleteReplicationGroupResponse deleteReplicationGroup(Consumer<DeleteReplicationGroupRequest.Builder> deleteReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, SnapshotAlreadyExistsException, SnapshotFeatureNotSupportedException, SnapshotQuotaExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting
RetainPrimaryCluster=true.When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
-
CreateSnapshotpermission is required to create a final snapshot. Without this permission, the API call will fail with anAccess Deniedexception. -
This operation is valid for Redis OSS only.
This is a convenience which creates an instance of the
DeleteReplicationGroupRequest.Builderavoiding the need to create one manually viaDeleteReplicationGroupRequest.builder()- Parameters:
deleteReplicationGroupRequest- AConsumerthat will call methods onDeleteReplicationGroupRequest.Builderto create a request. Represents the input of aDeleteReplicationGroupoperation.- Returns:
- Result of the DeleteReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.microcache 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteServerlessCache
default DeleteServerlessCacheResponse deleteServerlessCache(DeleteServerlessCacheRequest deleteServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a specified existing serverless cache.
CreateServerlessCacheSnapshotpermission is required to create a final snapshot. Without this permission, the API call will fail with anAccess Deniedexception.- Parameters:
deleteServerlessCacheRequest-- Returns:
- Result of the DeleteServerlessCache operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerlessCache
default DeleteServerlessCacheResponse deleteServerlessCache(Consumer<DeleteServerlessCacheRequest.Builder> deleteServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotAlreadyExistsException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes a specified existing serverless cache.
CreateServerlessCacheSnapshotpermission is required to create a final snapshot. Without this permission, the API call will fail with anAccess Deniedexception.
This is a convenience which creates an instance of the
DeleteServerlessCacheRequest.Builderavoiding the need to create one manually viaDeleteServerlessCacheRequest.builder()- Parameters:
deleteServerlessCacheRequest- AConsumerthat will call methods onDeleteServerlessCacheRequest.Builderto create a request.- Returns:
- Result of the DeleteServerlessCache operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerlessCacheSnapshot
default DeleteServerlessCacheSnapshotResponse deleteServerlessCacheSnapshot(DeleteServerlessCacheSnapshotRequest deleteServerlessCacheSnapshotRequest) throws ServiceLinkedRoleNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
deleteServerlessCacheSnapshotRequest-- Returns:
- Result of the DeleteServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerlessCacheSnapshot
default DeleteServerlessCacheSnapshotResponse deleteServerlessCacheSnapshot(Consumer<DeleteServerlessCacheSnapshotRequest.Builder> deleteServerlessCacheSnapshotRequest) throws ServiceLinkedRoleNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
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.Builderavoiding the need to create one manually viaDeleteServerlessCacheSnapshotRequest.builder()- Parameters:
deleteServerlessCacheSnapshotRequest- AConsumerthat will call methods onDeleteServerlessCacheSnapshotRequest.Builderto create a request.- Returns:
- Result of the DeleteServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Valkey or Redis OSS only.
- Parameters:
deleteSnapshotRequest- Represents the input of aDeleteSnapshotoperation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSnapshot
default DeleteSnapshotResponse deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) throws SnapshotNotFoundException, InvalidSnapshotStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Valkey or Redis OSS only.
This is a convenience which creates an instance of the
DeleteSnapshotRequest.Builderavoiding the need to create one manually viaDeleteSnapshotRequest.builder()- Parameters:
deleteSnapshotRequest- AConsumerthat will call methods onDeleteSnapshotRequest.Builderto create a request. Represents the input of aDeleteSnapshotoperation.- Returns:
- Result of the DeleteSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws InvalidUserStateException, UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, DefaultUserAssociatedToUserGroupException, AwsServiceException, SdkClientException, ElastiCacheException
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:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws InvalidUserStateException, UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, DefaultUserAssociatedToUserGroupException, AwsServiceException, SdkClientException, ElastiCacheException
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.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserGroup
default DeleteUserGroupResponse deleteUserGroup(DeleteUserGroupRequest deleteUserGroupRequest) throws UserGroupNotFoundException, InvalidUserGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
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:
- Result of the DeleteUserGroup operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existInvalidUserGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserGroup
default DeleteUserGroupResponse deleteUserGroup(Consumer<DeleteUserGroupRequest.Builder> deleteUserGroupRequest) throws UserGroupNotFoundException, InvalidUserGroupStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
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.Builderavoiding the need to create one manually viaDeleteUserGroupRequest.builder()- Parameters:
deleteUserGroupRequest- AConsumerthat will call methods onDeleteUserGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteUserGroup operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existInvalidUserGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters(DescribeCacheClustersRequest describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
- Parameters:
describeCacheClustersRequest- Represents the input of aDescribeCacheClustersoperation.- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
This is a convenience which creates an instance of the
DescribeCacheClustersRequest.Builderavoiding the need to create one manually viaDescribeCacheClustersRequest.builder()- Parameters:
describeCacheClustersRequest- AConsumerthat will call methods onDescribeCacheClustersRequest.Builderto create a request. Represents the input of aDescribeCacheClustersoperation.- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheClusters
default DescribeCacheClustersResponse describeCacheClusters() throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
- Returns:
- Result of the DescribeCacheClusters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeCacheClusters(DescribeCacheClustersRequest), AWS API Documentation
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator() throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeCacheClustersPaginator(DescribeCacheClustersRequest), AWS API Documentation
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator(DescribeCacheClustersRequest describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation.- Parameters:
describeCacheClustersRequest- Represents the input of aDescribeCacheClustersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheClustersPaginator
default DescribeCacheClustersIterable describeCacheClustersPaginator(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest) throws CacheClusterNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client .describeCacheClustersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheClustersIterable responses = client.describeCacheClustersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheClustersRequest.Builderavoiding the need to create one manually viaDescribeCacheClustersRequest.builder()- Parameters:
describeCacheClustersRequest- AConsumerthat will call methods onDescribeCacheClustersRequest.Builderto create a request. Represents the input of aDescribeCacheClustersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
- Parameters:
describeCacheEngineVersionsRequest- Represents the input of aDescribeCacheEngineVersionsoperation.- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
This is a convenience which creates an instance of the
DescribeCacheEngineVersionsRequest.Builderavoiding the need to create one manually viaDescribeCacheEngineVersionsRequest.builder()- Parameters:
describeCacheEngineVersionsRequest- AConsumerthat will call methods onDescribeCacheEngineVersionsRequest.Builderto create a request. Represents the input of aDescribeCacheEngineVersionsoperation.- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheEngineVersions
default DescribeCacheEngineVersionsResponse describeCacheEngineVersions() throws AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of the available cache engines and their versions.
- Returns:
- Result of the DescribeCacheEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeCacheEngineVersions(DescribeCacheEngineVersionsRequest), AWS API Documentation
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator() throws AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest), AWS API Documentation
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(DescribeCacheEngineVersionsRequest describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation.- Parameters:
describeCacheEngineVersionsRequest- Represents the input of aDescribeCacheEngineVersionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheEngineVersionsPaginator
default DescribeCacheEngineVersionsIterable describeCacheEngineVersionsPaginator(Consumer<DescribeCacheEngineVersionsRequest.Builder> describeCacheEngineVersionsRequest) throws AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client .describeCacheEngineVersionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheEngineVersionsIterable responses = client.describeCacheEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheEngineVersions(software.amazon.awssdk.services.elasticache.model.DescribeCacheEngineVersionsRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheEngineVersionsRequest.Builderavoiding the need to create one manually viaDescribeCacheEngineVersionsRequest.builder()- Parameters:
describeCacheEngineVersionsRequest- AConsumerthat will call methods onDescribeCacheEngineVersionsRequest.Builderto create a request. Represents the input of aDescribeCacheEngineVersionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
- Parameters:
describeCacheParameterGroupsRequest- Represents the input of aDescribeCacheParameterGroupsoperation.- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
This is a convenience which creates an instance of the
DescribeCacheParameterGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheParameterGroupsRequest.builder()- Parameters:
describeCacheParameterGroupsRequest- AConsumerthat will call methods onDescribeCacheParameterGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheParameterGroupsoperation.- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameterGroups
default DescribeCacheParameterGroupsResponse describeCacheParameterGroups() throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
- Returns:
- Result of the DescribeCacheParameterGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeCacheParameterGroups(DescribeCacheParameterGroupsRequest), AWS API Documentation
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator() throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest), AWS API Documentation
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(DescribeCacheParameterGroupsRequest describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation.- Parameters:
describeCacheParameterGroupsRequest- Represents the input of aDescribeCacheParameterGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameterGroupsPaginator
default DescribeCacheParameterGroupsIterable describeCacheParameterGroupsPaginator(Consumer<DescribeCacheParameterGroupsRequest.Builder> describeCacheParameterGroupsRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client .describeCacheParameterGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParameterGroupsIterable responses = client.describeCacheParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameterGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheParameterGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheParameterGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheParameterGroupsRequest.builder()- Parameters:
describeCacheParameterGroupsRequest- AConsumerthat will call methods onDescribeCacheParameterGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheParameterGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameters
default DescribeCacheParametersResponse describeCacheParameters(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the detailed parameter list for a particular cache parameter group.
- Parameters:
describeCacheParametersRequest- Represents the input of aDescribeCacheParametersoperation.- Returns:
- Result of the DescribeCacheParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParameters
default DescribeCacheParametersResponse describeCacheParameters(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the detailed parameter list for a particular cache parameter group.
This is a convenience which creates an instance of the
DescribeCacheParametersRequest.Builderavoiding the need to create one manually viaDescribeCacheParametersRequest.builder()- Parameters:
describeCacheParametersRequest- AConsumerthat will call methods onDescribeCacheParametersRequest.Builderto create a request. Represents the input of aDescribeCacheParametersoperation.- Returns:
- Result of the DescribeCacheParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParametersPaginator
default DescribeCacheParametersIterable describeCacheParametersPaginator(DescribeCacheParametersRequest describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client .describeCacheParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)operation.- Parameters:
describeCacheParametersRequest- Represents the input of aDescribeCacheParametersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheParametersPaginator
default DescribeCacheParametersIterable describeCacheParametersPaginator(Consumer<DescribeCacheParametersRequest.Builder> describeCacheParametersRequest) throws CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client .describeCacheParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheParametersIterable responses = client.describeCacheParametersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheParameters(software.amazon.awssdk.services.elasticache.model.DescribeCacheParametersRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheParametersRequest.Builderavoiding the need to create one manually viaDescribeCacheParametersRequest.builder()- Parameters:
describeCacheParametersRequest- AConsumerthat will call methods onDescribeCacheParametersRequest.Builderto create a request. Represents the input of aDescribeCacheParametersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSecurityGroups
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
- Parameters:
describeCacheSecurityGroupsRequest- Represents the input of aDescribeCacheSecurityGroupsoperation.- Returns:
- Result of the DescribeCacheSecurityGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSecurityGroups
default DescribeCacheSecurityGroupsResponse describeCacheSecurityGroups(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
This is a convenience which creates an instance of the
DescribeCacheSecurityGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheSecurityGroupsRequest.builder()- Parameters:
describeCacheSecurityGroupsRequest- AConsumerthat will call methods onDescribeCacheSecurityGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheSecurityGroupsoperation.- Returns:
- Result of the DescribeCacheSecurityGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSecurityGroupsPaginator
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(DescribeCacheSecurityGroupsRequest describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client .describeCacheSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)operation.- Parameters:
describeCacheSecurityGroupsRequest- Represents the input of aDescribeCacheSecurityGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSecurityGroupsPaginator
default DescribeCacheSecurityGroupsIterable describeCacheSecurityGroupsPaginator(Consumer<DescribeCacheSecurityGroupsRequest.Builder> describeCacheSecurityGroupsRequest) throws CacheSecurityGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client .describeCacheSecurityGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSecurityGroupsIterable responses = client.describeCacheSecurityGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSecurityGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSecurityGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheSecurityGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheSecurityGroupsRequest.builder()- Parameters:
describeCacheSecurityGroupsRequest- AConsumerthat will call methods onDescribeCacheSecurityGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheSecurityGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
- Parameters:
describeCacheSubnetGroupsRequest- Represents the input of aDescribeCacheSubnetGroupsoperation.- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
This is a convenience which creates an instance of the
DescribeCacheSubnetGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheSubnetGroupsRequest.builder()- Parameters:
describeCacheSubnetGroupsRequest- AConsumerthat will call methods onDescribeCacheSubnetGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheSubnetGroupsoperation.- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSubnetGroups
default DescribeCacheSubnetGroupsResponse describeCacheSubnetGroups() throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
- Returns:
- Result of the DescribeCacheSubnetGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest), AWS API Documentation
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator() throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest), AWS API Documentation
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(DescribeCacheSubnetGroupsRequest describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation.- Parameters:
describeCacheSubnetGroupsRequest- Represents the input of aDescribeCacheSubnetGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeCacheSubnetGroupsPaginator
default DescribeCacheSubnetGroupsIterable describeCacheSubnetGroupsPaginator(Consumer<DescribeCacheSubnetGroupsRequest.Builder> describeCacheSubnetGroupsRequest) throws CacheSubnetGroupNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client .describeCacheSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeCacheSubnetGroupsIterable responses = client.describeCacheSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCacheSubnetGroups(software.amazon.awssdk.services.elasticache.model.DescribeCacheSubnetGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeCacheSubnetGroupsRequest.Builderavoiding the need to create one manually viaDescribeCacheSubnetGroupsRequest.builder()- Parameters:
describeCacheSubnetGroupsRequest- AConsumerthat will call methods onDescribeCacheSubnetGroupsRequest.Builderto create a request. Represents the input of aDescribeCacheSubnetGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the default engine and system parameter information for the specified cache engine.
- Parameters:
describeEngineDefaultParametersRequest- Represents the input of aDescribeEngineDefaultParametersoperation.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns the default engine and system parameter information for the specified cache engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builderavoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()- Parameters:
describeEngineDefaultParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultParametersRequest.Builderto create a request. Represents the input of aDescribeEngineDefaultParametersoperation.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)operation.- Parameters:
describeEngineDefaultParametersRequest- Represents the input of aDescribeEngineDefaultParametersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.elasticache.model.DescribeEngineDefaultParametersRequest)operation.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builderavoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()- Parameters:
describeEngineDefaultParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultParametersRequest.Builderto create a request. Represents the input of aDescribeEngineDefaultParametersoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
- Parameters:
describeEventsRequest- Represents the input of aDescribeEventsoperation.- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request. Represents the input of aDescribeEventsoperation.- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents() throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeEvents(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeEventsPaginator(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation.- Parameters:
describeEventsRequest- Represents the input of aDescribeEventsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest)operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request. Represents the input of aDescribeEventsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalReplicationGroups
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
- Parameters:
describeGlobalReplicationGroupsRequest-- Returns:
- Result of the DescribeGlobalReplicationGroups operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalReplicationGroups
default DescribeGlobalReplicationGroupsResponse describeGlobalReplicationGroups(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
This is a convenience which creates an instance of the
DescribeGlobalReplicationGroupsRequest.Builderavoiding the need to create one manually viaDescribeGlobalReplicationGroupsRequest.builder()- Parameters:
describeGlobalReplicationGroupsRequest- AConsumerthat will call methods onDescribeGlobalReplicationGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeGlobalReplicationGroups operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalReplicationGroupsPaginator
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(DescribeGlobalReplicationGroupsRequest describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client .describeGlobalReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)operation.- Parameters:
describeGlobalReplicationGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeGlobalReplicationGroupsPaginator
default DescribeGlobalReplicationGroupsIterable describeGlobalReplicationGroupsPaginator(Consumer<DescribeGlobalReplicationGroupsRequest.Builder> describeGlobalReplicationGroupsRequest) throws GlobalReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client .describeGlobalReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeGlobalReplicationGroupsIterable responses = client.describeGlobalReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeGlobalReplicationGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeGlobalReplicationGroupsRequest.Builderavoiding the need to create one manually viaDescribeGlobalReplicationGroupsRequest.builder()- Parameters:
describeGlobalReplicationGroupsRequest- AConsumerthat will call methods onDescribeGlobalReplicationGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroupsreturns information about all replication groups.This operation is valid for Valkey or Redis OSS only.
- Parameters:
describeReplicationGroupsRequest- Represents the input of aDescribeReplicationGroupsoperation.- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroupsreturns 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.Builderavoiding the need to create one manually viaDescribeReplicationGroupsRequest.builder()- Parameters:
describeReplicationGroupsRequest- AConsumerthat will call methods onDescribeReplicationGroupsRequest.Builderto create a request. Represents the input of aDescribeReplicationGroupsoperation.- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationGroups
default DescribeReplicationGroupsResponse describeReplicationGroups() throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a particular replication group. If no identifier is specified,
DescribeReplicationGroupsreturns information about all replication groups.This operation is valid for Valkey or Redis OSS only.
- Returns:
- Result of the DescribeReplicationGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeReplicationGroups(DescribeReplicationGroupsRequest), AWS API Documentation
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator() throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest), AWS API Documentation
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(DescribeReplicationGroupsRequest describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation.- Parameters:
describeReplicationGroupsRequest- Represents the input of aDescribeReplicationGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReplicationGroupsPaginator
default DescribeReplicationGroupsIterable describeReplicationGroupsPaginator(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest) throws ReplicationGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client .describeReplicationGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReplicationGroupsIterable responses = client.describeReplicationGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeReplicationGroupsRequest.Builderavoiding the need to create one manually viaDescribeReplicationGroupsRequest.builder()- Parameters:
describeReplicationGroupsRequest- AConsumerthat will call methods onDescribeReplicationGroupsRequest.Builderto create a request. Represents the input of aDescribeReplicationGroupsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
- Parameters:
describeReservedCacheNodesRequest- Represents the input of aDescribeReservedCacheNodesoperation.- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
This is a convenience which creates an instance of the
DescribeReservedCacheNodesRequest.Builderavoiding the need to create one manually viaDescribeReservedCacheNodesRequest.builder()- Parameters:
describeReservedCacheNodesRequest- AConsumerthat will call methods onDescribeReservedCacheNodesRequest.Builderto create a request. Represents the input of aDescribeReservedCacheNodesoperation.- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodes
default DescribeReservedCacheNodesResponse describeReservedCacheNodes() throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
- Returns:
- Result of the DescribeReservedCacheNodes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeReservedCacheNodes(DescribeReservedCacheNodesRequest), AWS API Documentation
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator() throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest), AWS API Documentation
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(DescribeReservedCacheNodesRequest describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation.- Parameters:
describeReservedCacheNodesRequest- Represents the input of aDescribeReservedCacheNodesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodesPaginator
default DescribeReservedCacheNodesIterable describeReservedCacheNodesPaginator(Consumer<DescribeReservedCacheNodesRequest.Builder> describeReservedCacheNodesRequest) throws ReservedCacheNodeNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client .describeReservedCacheNodesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesIterable responses = client.describeReservedCacheNodesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodes(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedCacheNodesRequest.Builderavoiding the need to create one manually viaDescribeReservedCacheNodesRequest.builder()- Parameters:
describeReservedCacheNodesRequest- AConsumerthat will call methods onDescribeReservedCacheNodesRequest.Builderto create a request. Represents the input of aDescribeReservedCacheNodesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
- Parameters:
describeReservedCacheNodesOfferingsRequest- Represents the input of aDescribeReservedCacheNodesOfferingsoperation.- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
This is a convenience which creates an instance of the
DescribeReservedCacheNodesOfferingsRequest.Builderavoiding the need to create one manually viaDescribeReservedCacheNodesOfferingsRequest.builder()- Parameters:
describeReservedCacheNodesOfferingsRequest- AConsumerthat will call methods onDescribeReservedCacheNodesOfferingsRequest.Builderto create a request. Represents the input of aDescribeReservedCacheNodesOfferingsoperation.- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodesOfferings
default DescribeReservedCacheNodesOfferingsResponse describeReservedCacheNodesOfferings() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Lists available reserved cache node offerings.
- Returns:
- Result of the DescribeReservedCacheNodesOfferings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest), AWS API Documentation
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator() throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest), AWS API Documentation
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(DescribeReservedCacheNodesOfferingsRequest describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation.- Parameters:
describeReservedCacheNodesOfferingsRequest- Represents the input of aDescribeReservedCacheNodesOfferingsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeReservedCacheNodesOfferingsPaginator
default DescribeReservedCacheNodesOfferingsIterable describeReservedCacheNodesOfferingsPaginator(Consumer<DescribeReservedCacheNodesOfferingsRequest.Builder> describeReservedCacheNodesOfferingsRequest) throws ReservedCacheNodesOfferingNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client .describeReservedCacheNodesOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeReservedCacheNodesOfferingsIterable responses = client.describeReservedCacheNodesOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedCacheNodesOfferings(software.amazon.awssdk.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedCacheNodesOfferingsRequest.Builderavoiding the need to create one manually viaDescribeReservedCacheNodesOfferingsRequest.builder()- Parameters:
describeReservedCacheNodesOfferingsRequest- AConsumerthat will call methods onDescribeReservedCacheNodesOfferingsRequest.Builderto create a request. Represents the input of aDescribeReservedCacheNodesOfferingsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCacheSnapshots
default DescribeServerlessCacheSnapshotsResponse describeServerlessCacheSnapshots(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
- Parameters:
describeServerlessCacheSnapshotsRequest-- Returns:
- Result of the DescribeServerlessCacheSnapshots operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCacheSnapshots
default DescribeServerlessCacheSnapshotsResponse describeServerlessCacheSnapshots(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
This is a convenience which creates an instance of the
DescribeServerlessCacheSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeServerlessCacheSnapshotsRequest.builder()- Parameters:
describeServerlessCacheSnapshotsRequest- AConsumerthat will call methods onDescribeServerlessCacheSnapshotsRequest.Builderto create a request.- Returns:
- Result of the DescribeServerlessCacheSnapshots operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCacheSnapshotsPaginator
default DescribeServerlessCacheSnapshotsIterable describeServerlessCacheSnapshotsPaginator(DescribeServerlessCacheSnapshotsRequest describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client .describeServerlessCacheSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)operation.- Parameters:
describeServerlessCacheSnapshotsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCacheSnapshotsPaginator
default DescribeServerlessCacheSnapshotsIterable describeServerlessCacheSnapshotsPaginator(Consumer<DescribeServerlessCacheSnapshotsRequest.Builder> describeServerlessCacheSnapshotsRequest) throws ServerlessCacheNotFoundException, ServerlessCacheSnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client .describeServerlessCacheSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCacheSnapshotsIterable responses = client.describeServerlessCacheSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServerlessCacheSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCacheSnapshotsRequest)operation.
This is a convenience which creates an instance of the
DescribeServerlessCacheSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeServerlessCacheSnapshotsRequest.builder()- Parameters:
describeServerlessCacheSnapshotsRequest- AConsumerthat will call methods onDescribeServerlessCacheSnapshotsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCaches
default DescribeServerlessCachesResponse describeServerlessCaches(DescribeServerlessCachesRequest describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
- Parameters:
describeServerlessCachesRequest-- Returns:
- Result of the DescribeServerlessCaches operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCaches
default DescribeServerlessCachesResponse describeServerlessCaches(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeServerlessCachesRequest.Builderavoiding the need to create one manually viaDescribeServerlessCachesRequest.builder()- Parameters:
describeServerlessCachesRequest- AConsumerthat will call methods onDescribeServerlessCachesRequest.Builderto create a request.- Returns:
- Result of the DescribeServerlessCaches operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCachesPaginator
default DescribeServerlessCachesIterable describeServerlessCachesPaginator(DescribeServerlessCachesRequest describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client .describeServerlessCachesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)operation.- Parameters:
describeServerlessCachesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServerlessCachesPaginator
default DescribeServerlessCachesIterable describeServerlessCachesPaginator(Consumer<DescribeServerlessCachesRequest.Builder> describeServerlessCachesRequest) throws ServerlessCacheNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client .describeServerlessCachesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServerlessCachesIterable responses = client.describeServerlessCachesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServerlessCaches(software.amazon.awssdk.services.elasticache.model.DescribeServerlessCachesRequest)operation.
This is a convenience which creates an instance of the
DescribeServerlessCachesRequest.Builderavoiding the need to create one manually viaDescribeServerlessCachesRequest.builder()- Parameters:
describeServerlessCachesRequest- AConsumerthat will call methods onDescribeServerlessCachesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceUpdates
default DescribeServiceUpdatesResponse describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the service updates
- Parameters:
describeServiceUpdatesRequest-- Returns:
- Result of the DescribeServiceUpdates operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceUpdates
default DescribeServiceUpdatesResponse describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the service updates
This is a convenience which creates an instance of the
DescribeServiceUpdatesRequest.Builderavoiding the need to create one manually viaDescribeServiceUpdatesRequest.builder()- Parameters:
describeServiceUpdatesRequest- AConsumerthat will call methods onDescribeServiceUpdatesRequest.Builderto create a request.- Returns:
- Result of the DescribeServiceUpdates operation returned by the service.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client .describeServiceUpdatesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)operation.- Parameters:
describeServiceUpdatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesIterable describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) throws ServiceUpdateNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client .describeServiceUpdatesPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeServiceUpdatesIterable responses = client.describeServiceUpdatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeServiceUpdates(software.amazon.awssdk.services.elasticache.model.DescribeServiceUpdatesRequest)operation.
This is a convenience which creates an instance of the
DescribeServiceUpdatesRequest.Builderavoiding the need to create one manually viaDescribeServiceUpdatesRequest.builder()- Parameters:
describeServiceUpdatesRequest- AConsumerthat will call methods onDescribeServiceUpdatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServiceUpdateNotFoundException- The service update doesn't existInvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about cluster or replication group snapshots. By default,
DescribeSnapshotslists 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 aDescribeSnapshotsMessageoperation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about cluster or replication group snapshots. By default,
DescribeSnapshotslists 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.Builderavoiding the need to create one manually viaDescribeSnapshotsRequest.builder()- Parameters:
describeSnapshotsRequest- AConsumerthat will call methods onDescribeSnapshotsRequest.Builderto create a request. Represents the input of aDescribeSnapshotsMessageoperation.- Returns:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshots
default DescribeSnapshotsResponse describeSnapshots() throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns information about cluster or replication group snapshots. By default,
DescribeSnapshotslists 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:
- Result of the DescribeSnapshots operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeSnapshots(DescribeSnapshotsRequest), AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator() throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeSnapshotsPaginator(DescribeSnapshotsRequest), AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation.- Parameters:
describeSnapshotsRequest- Represents the input of aDescribeSnapshotsMessageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSnapshotsPaginator
default DescribeSnapshotsIterable describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) throws CacheClusterNotFoundException, SnapshotNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client .describeSnapshotsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeSnapshotsIterable responses = client.describeSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeSnapshots(software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest)operation.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builderavoiding the need to create one manually viaDescribeSnapshotsRequest.builder()- Parameters:
describeSnapshotsRequest- AConsumerthat will call methods onDescribeSnapshotsRequest.Builderto create a request. Represents the input of aDescribeSnapshotsMessageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateActions
default DescribeUpdateActionsResponse describeUpdateActions(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the update actions
- Parameters:
describeUpdateActionsRequest-- Returns:
- Result of the DescribeUpdateActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateActions
default DescribeUpdateActionsResponse describeUpdateActions(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns details of the update actions
This is a convenience which creates an instance of the
DescribeUpdateActionsRequest.Builderavoiding the need to create one manually viaDescribeUpdateActionsRequest.builder()- Parameters:
describeUpdateActionsRequest- AConsumerthat will call methods onDescribeUpdateActionsRequest.Builderto create a request.- Returns:
- Result of the DescribeUpdateActions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateActionsPaginator
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(DescribeUpdateActionsRequest describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client .describeUpdateActionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)operation.- Parameters:
describeUpdateActionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUpdateActionsPaginator
default DescribeUpdateActionsIterable describeUpdateActionsPaginator(Consumer<DescribeUpdateActionsRequest.Builder> describeUpdateActionsRequest) throws InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client .describeUpdateActionsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUpdateActionsIterable responses = client.describeUpdateActionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUpdateActions(software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest)operation.
This is a convenience which creates an instance of the
DescribeUpdateActionsRequest.Builderavoiding the need to create one manually viaDescribeUpdateActionsRequest.builder()- Parameters:
describeUpdateActionsRequest- AConsumerthat will call methods onDescribeUpdateActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserGroups
default DescribeUserGroupsResponse describeUserGroups(DescribeUserGroupsRequest describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of user groups.
- Parameters:
describeUserGroupsRequest-- Returns:
- Result of the DescribeUserGroups operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserGroups
default DescribeUserGroupsResponse describeUserGroups(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of user groups.
This is a convenience which creates an instance of the
DescribeUserGroupsRequest.Builderavoiding the need to create one manually viaDescribeUserGroupsRequest.builder()- Parameters:
describeUserGroupsRequest- AConsumerthat will call methods onDescribeUserGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeUserGroups operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserGroupsPaginator
default DescribeUserGroupsIterable describeUserGroupsPaginator(DescribeUserGroupsRequest describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client .describeUserGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)operation.- Parameters:
describeUserGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUserGroupsPaginator
default DescribeUserGroupsIterable describeUserGroupsPaginator(Consumer<DescribeUserGroupsRequest.Builder> describeUserGroupsRequest) throws UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client .describeUserGroupsPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUserGroupsIterable responses = client.describeUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUserGroups(software.amazon.awssdk.services.elasticache.model.DescribeUserGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeUserGroupsRequest.Builderavoiding the need to create one manually viaDescribeUserGroupsRequest.builder()- Parameters:
describeUserGroupsRequest- AConsumerthat will call methods onDescribeUserGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUsers
default DescribeUsersResponse describeUsers(DescribeUsersRequest describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of users.
- Parameters:
describeUsersRequest-- Returns:
- Result of the DescribeUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUsers
default DescribeUsersResponse describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Returns a list of users.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builderavoiding the need to create one manually viaDescribeUsersRequest.builder()- Parameters:
describeUsersRequest- AConsumerthat will call methods onDescribeUsersRequest.Builderto create a request.- Returns:
- Result of the DescribeUsers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(DescribeUsersRequest describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client .describeUsersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)operation.- Parameters:
describeUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUsersPaginator
default DescribeUsersIterable describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) throws UserNotFoundException, ServiceLinkedRoleNotFoundException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
This is a variant of
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client .describeUsersPaginator(request); for (software.amazon.awssdk.services.elasticache.model.DescribeUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticache.paginators.DescribeUsersIterable responses = client.describeUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeUsers(software.amazon.awssdk.services.elasticache.model.DescribeUsersRequest)operation.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builderavoiding the need to create one manually viaDescribeUsersRequest.builder()- Parameters:
describeUsersRequest- AConsumerthat will call methods onDescribeUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateGlobalReplicationGroup
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest disassociateGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
- Parameters:
disassociateGlobalReplicationGroupRequest-- Returns:
- Result of the DisassociateGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateGlobalReplicationGroup
default DisassociateGlobalReplicationGroupResponse disassociateGlobalReplicationGroup(Consumer<DisassociateGlobalReplicationGroupRequest.Builder> disassociateGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
This is a convenience which creates an instance of the
DisassociateGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaDisassociateGlobalReplicationGroupRequest.builder()- Parameters:
disassociateGlobalReplicationGroupRequest- AConsumerthat will call methods onDisassociateGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the DisassociateGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
exportServerlessCacheSnapshot
default ExportServerlessCacheSnapshotResponse exportServerlessCacheSnapshot(ExportServerlessCacheSnapshotRequest exportServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
- Parameters:
exportServerlessCacheSnapshotRequest-- Returns:
- Result of the ExportServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
exportServerlessCacheSnapshot
default ExportServerlessCacheSnapshotResponse exportServerlessCacheSnapshot(Consumer<ExportServerlessCacheSnapshotRequest.Builder> exportServerlessCacheSnapshotRequest) throws ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
This is a convenience which creates an instance of the
ExportServerlessCacheSnapshotRequest.Builderavoiding the need to create one manually viaExportServerlessCacheSnapshotRequest.builder()- Parameters:
exportServerlessCacheSnapshotRequest- AConsumerthat will call methods onExportServerlessCacheSnapshotRequest.Builderto create a request.- Returns:
- Result of the ExportServerlessCacheSnapshot operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
failoverGlobalReplicationGroup
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
- Parameters:
failoverGlobalReplicationGroupRequest-- Returns:
- Result of the FailoverGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
failoverGlobalReplicationGroup
default FailoverGlobalReplicationGroupResponse failoverGlobalReplicationGroup(Consumer<FailoverGlobalReplicationGroupRequest.Builder> failoverGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
This is a convenience which creates an instance of the
FailoverGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaFailoverGlobalReplicationGroupRequest.builder()- Parameters:
failoverGlobalReplicationGroupRequest- AConsumerthat will call methods onFailoverGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the FailoverGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
increaseNodeGroupsInGlobalReplicationGroup
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest increaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Increase the number of node groups in the Global datastore
- Parameters:
increaseNodeGroupsInGlobalReplicationGroupRequest-- Returns:
- Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
increaseNodeGroupsInGlobalReplicationGroup
default IncreaseNodeGroupsInGlobalReplicationGroupResponse increaseNodeGroupsInGlobalReplicationGroup(Consumer<IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builder> increaseNodeGroupsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Increase the number of node groups in the Global datastore
This is a convenience which creates an instance of the
IncreaseNodeGroupsInGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaIncreaseNodeGroupsInGlobalReplicationGroupRequest.builder()- Parameters:
increaseNodeGroupsInGlobalReplicationGroupRequest- AConsumerthat will call methods onIncreaseNodeGroupsInGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the IncreaseNodeGroupsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
increaseReplicaCount
default IncreaseReplicaCountResponse increaseReplicaCount(IncreaseReplicaCountRequest increaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Dynamically increases the number of replicas in a 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:
- Result of the IncreaseReplicaCount operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.NoOperationException- The operation was not performed because no changes were required.InvalidKmsKeyException- The KMS key supplied is not valid.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
increaseReplicaCount
default IncreaseReplicaCountResponse increaseReplicaCount(Consumer<IncreaseReplicaCountRequest.Builder> increaseReplicaCountRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, ClusterQuotaForCustomerExceededException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, NoOperationException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Dynamically increases the number of replicas in a 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.Builderavoiding the need to create one manually viaIncreaseReplicaCountRequest.builder()- Parameters:
increaseReplicaCountRequest- AConsumerthat will call methods onIncreaseReplicaCountRequest.Builderto create a request.- Returns:
- Result of the IncreaseReplicaCount operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.ClusterQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of clusters per customer.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.NoOperationException- The operation was not performed because no changes were required.InvalidKmsKeyException- The KMS key supplied is not valid.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAllowedNodeTypeModifications
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest listAllowedNodeTypeModificationsRequest) throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all available node types that you can scale with your cluster's replication group's current node type.
When you use the
ModifyCacheClusterorModifyReplicationGroupoperations to scale your cluster or replication group, the value of theCacheNodeTypeparameter must be one of the node types returned by this operation.- Parameters:
listAllowedNodeTypeModificationsRequest- The input parameters for theListAllowedNodeTypeModificationsoperation.- Returns:
- Result of the ListAllowedNodeTypeModifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAllowedNodeTypeModifications
default ListAllowedNodeTypeModificationsResponse listAllowedNodeTypeModifications(Consumer<ListAllowedNodeTypeModificationsRequest.Builder> listAllowedNodeTypeModificationsRequest) throws CacheClusterNotFoundException, ReplicationGroupNotFoundException, InvalidParameterCombinationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all available node types that you can scale with your cluster's replication group's current node type.
When you use the
ModifyCacheClusterorModifyReplicationGroupoperations to scale your cluster or replication group, the value of theCacheNodeTypeparameter must be one of the node types returned by this operation.
This is a convenience which creates an instance of the
ListAllowedNodeTypeModificationsRequest.Builderavoiding the need to create one manually viaListAllowedNodeTypeModificationsRequest.builder()- Parameters:
listAllowedNodeTypeModificationsRequest- AConsumerthat will call methods onListAllowedNodeTypeModificationsRequest.Builderto create a request. The input parameters for theListAllowedNodeTypeModificationsoperation.- Returns:
- Result of the ListAllowedNodeTypeModifications operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state,
ListTagsForResourcereturns an error.- Parameters:
listTagsForResourceRequest- The input parameters for theListTagsForResourceoperation.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, AwsServiceException, SdkClientException, ElastiCacheException
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state,
ListTagsForResourcereturns an error.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. The input parameters for theListTagsForResourceoperation.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheCluster
default ModifyCacheClusterResponse modifyCacheCluster(ModifyCacheClusterRequest modifyCacheClusterRequest) throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
- Parameters:
modifyCacheClusterRequest- Represents the input of aModifyCacheClusteroperation.- Returns:
- Result of the ModifyCacheCluster operation returned by the service.
- Throws:
InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheCluster
default ModifyCacheClusterResponse modifyCacheCluster(Consumer<ModifyCacheClusterRequest.Builder> modifyCacheClusterRequest) throws InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
This is a convenience which creates an instance of the
ModifyCacheClusterRequest.Builderavoiding the need to create one manually viaModifyCacheClusterRequest.builder()- Parameters:
modifyCacheClusterRequest- AConsumerthat will call methods onModifyCacheClusterRequest.Builderto create a request. Represents the input of aModifyCacheClusteroperation.- Returns:
- Result of the ModifyCacheCluster operation returned by the service.
- Throws:
InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheParameterGroup
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(ModifyCacheParameterGroupRequest modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
- Parameters:
modifyCacheParameterGroupRequest- Represents the input of aModifyCacheParameterGroupoperation.- Returns:
- Result of the ModifyCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheParameterGroup
default ModifyCacheParameterGroupResponse modifyCacheParameterGroup(Consumer<ModifyCacheParameterGroupRequest.Builder> modifyCacheParameterGroupRequest) throws CacheParameterGroupNotFoundException, InvalidCacheParameterGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
This is a convenience which creates an instance of the
ModifyCacheParameterGroupRequest.Builderavoiding the need to create one manually viaModifyCacheParameterGroupRequest.builder()- Parameters:
modifyCacheParameterGroupRequest- AConsumerthat will call methods onModifyCacheParameterGroupRequest.Builderto create a request. Represents the input of aModifyCacheParameterGroupoperation.- Returns:
- Result of the ModifyCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheSubnetGroup
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies an existing cache subnet group.
- Parameters:
modifyCacheSubnetGroupRequest- Represents the input of aModifyCacheSubnetGroupoperation.- Returns:
- Result of the ModifyCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyCacheSubnetGroup
default ModifyCacheSubnetGroupResponse modifyCacheSubnetGroup(Consumer<ModifyCacheSubnetGroupRequest.Builder> modifyCacheSubnetGroupRequest) throws CacheSubnetGroupNotFoundException, CacheSubnetQuotaExceededException, SubnetInUseException, InvalidSubnetException, SubnetNotAllowedException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies an existing cache subnet group.
This is a convenience which creates an instance of the
ModifyCacheSubnetGroupRequest.Builderavoiding the need to create one manually viaModifyCacheSubnetGroupRequest.builder()- Parameters:
modifyCacheSubnetGroupRequest- AConsumerthat will call methods onModifyCacheSubnetGroupRequest.Builderto create a request. Represents the input of aModifyCacheSubnetGroupoperation.- Returns:
- Result of the ModifyCacheSubnetGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyGlobalReplicationGroup
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest modifyGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a Global datastore.
- Parameters:
modifyGlobalReplicationGroupRequest-- Returns:
- Result of the ModifyGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyGlobalReplicationGroup
default ModifyGlobalReplicationGroupResponse modifyGlobalReplicationGroup(Consumer<ModifyGlobalReplicationGroupRequest.Builder> modifyGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a Global datastore.
This is a convenience which creates an instance of the
ModifyGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaModifyGlobalReplicationGroupRequest.builder()- Parameters:
modifyGlobalReplicationGroupRequest- AConsumerthat will call methods onModifyGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyReplicationGroup
default ModifyReplicationGroupResponse modifyReplicationGroup(ModifyReplicationGroupRequest modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidUserGroupStateException, UserGroupNotFoundException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
-
Scaling for Valkey or Redis OSS (cluster mode enabled) in the ElastiCache User Guide
-
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Valkey or Redis OSS only.
- Parameters:
modifyReplicationGroupRequest- Represents the input of aModifyReplicationGroupsoperation.- Returns:
- Result of the ModifyReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidUserGroupStateException- The user group is not in an active state.UserGroupNotFoundException- The user group was not found or does not existInvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
modifyReplicationGroup
default ModifyReplicationGroupResponse modifyReplicationGroup(Consumer<ModifyReplicationGroupRequest.Builder> modifyReplicationGroupRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidUserGroupStateException, UserGroupNotFoundException, InvalidCacheClusterStateException, InvalidCacheSecurityGroupStateException, InsufficientCacheClusterCapacityException, CacheClusterNotFoundException, NodeQuotaForClusterExceededException, NodeQuotaForCustomerExceededException, CacheSecurityGroupNotFoundException, CacheParameterGroupNotFoundException, InvalidVpcNetworkStateException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
-
Scaling for Valkey or Redis OSS (cluster mode enabled) in the ElastiCache User Guide
-
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Valkey or Redis OSS only.
This is a convenience which creates an instance of the
ModifyReplicationGroupRequest.Builderavoiding the need to create one manually viaModifyReplicationGroupRequest.builder()- Parameters:
modifyReplicationGroupRequest- AConsumerthat will call methods onModifyReplicationGroupRequest.Builderto create a request. Represents the input of aModifyReplicationGroupsoperation.- Returns:
- Result of the ModifyReplicationGroup operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidUserGroupStateException- The user group is not in an active state.UserGroupNotFoundException- The user group was not found or does not existInvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
modifyReplicationGroupShardConfiguration
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest modifyReplicationGroupShardConfigurationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
- Parameters:
modifyReplicationGroupShardConfigurationRequest- Represents the input for aModifyReplicationGroupShardConfigurationoperation.- Returns:
- Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.InvalidKmsKeyException- The KMS key supplied is not valid.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyReplicationGroupShardConfiguration
default ModifyReplicationGroupShardConfigurationResponse modifyReplicationGroupShardConfiguration(Consumer<ModifyReplicationGroupShardConfigurationRequest.Builder> modifyReplicationGroupShardConfigurationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, InvalidCacheClusterStateException, InvalidVpcNetworkStateException, InsufficientCacheClusterCapacityException, NodeGroupsPerReplicationGroupQuotaExceededException, NodeQuotaForCustomerExceededException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
This is a convenience which creates an instance of the
ModifyReplicationGroupShardConfigurationRequest.Builderavoiding the need to create one manually viaModifyReplicationGroupShardConfigurationRequest.builder()- Parameters:
modifyReplicationGroupShardConfigurationRequest- AConsumerthat will call methods onModifyReplicationGroupShardConfigurationRequest.Builderto create a request. Represents the input for aModifyReplicationGroupShardConfigurationoperation.- Returns:
- Result of the ModifyReplicationGroupShardConfiguration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidVpcNetworkStateException- The VPC network is in an invalid state.InsufficientCacheClusterCapacityException- The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.NodeGroupsPerReplicationGroupQuotaExceededException- The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90NodeQuotaForCustomerExceededException- The request cannot be processed because it would exceed the allowed number of cache nodes per customer.InvalidKmsKeyException- The KMS key supplied is not valid.InvalidParameterValueException- The value for a parameter is invalid.InvalidParameterCombinationException- Two or more incompatible parameters were specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElastiCacheException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
modifyServerlessCache
default ModifyServerlessCacheResponse modifyServerlessCache(ModifyServerlessCacheRequest modifyServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
This API modifies the attributes of a serverless cache.
- Parameters:
modifyServerlessCacheRequest-- Returns:
- Result of the ModifyServerlessCache operation returned by the service.
- Throws:
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 existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyServerlessCache
default ModifyServerlessCacheResponse modifyServerlessCache(Consumer<ModifyServerlessCacheRequest.Builder> modifyServerlessCacheRequest) throws ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidCredentialsException, InvalidUserGroupStateException, UserGroupNotFoundException, ServiceLinkedRoleNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
This API modifies the attributes of a serverless cache.
This is a convenience which creates an instance of the
ModifyServerlessCacheRequest.Builderavoiding the need to create one manually viaModifyServerlessCacheRequest.builder()- Parameters:
modifyServerlessCacheRequest- AConsumerthat will call methods onModifyServerlessCacheRequest.Builderto create a request.- Returns:
- Result of the ModifyServerlessCache operation returned by the service.
- Throws:
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 existServiceLinkedRoleNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyUser
default ModifyUserResponse modifyUser(ModifyUserRequest modifyUserRequest) throws UserNotFoundException, InvalidUserStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Changes user password(s) and/or access string.
- Parameters:
modifyUserRequest-- Returns:
- Result of the ModifyUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyUser
default ModifyUserResponse modifyUser(Consumer<ModifyUserRequest.Builder> modifyUserRequest) throws UserNotFoundException, InvalidUserStateException, ServiceLinkedRoleNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Changes user password(s) and/or access string.
This is a convenience which creates an instance of the
ModifyUserRequest.Builderavoiding the need to create one manually viaModifyUserRequest.builder()- Parameters:
modifyUserRequest- AConsumerthat will call methods onModifyUserRequest.Builderto create a request.- Returns:
- Result of the ModifyUser operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyUserGroup
default ModifyUserGroupResponse modifyUserGroup(ModifyUserGroupRequest modifyUserGroupRequest) throws UserGroupNotFoundException, UserNotFoundException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, InvalidUserGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Changes the list of users that belong to the user group.
- Parameters:
modifyUserGroupRequest-- Returns:
- Result of the ModifyUserGroup operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existUserNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
modifyUserGroup
default ModifyUserGroupResponse modifyUserGroup(Consumer<ModifyUserGroupRequest.Builder> modifyUserGroupRequest) throws UserGroupNotFoundException, UserNotFoundException, DuplicateUserNameException, ServiceLinkedRoleNotFoundException, DefaultUserRequiredException, InvalidUserGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Changes the list of users that belong to the user group.
This is a convenience which creates an instance of the
ModifyUserGroupRequest.Builderavoiding the need to create one manually viaModifyUserGroupRequest.builder()- Parameters:
modifyUserGroupRequest- AConsumerthat will call methods onModifyUserGroupRequest.Builderto create a request.- Returns:
- Result of the ModifyUserGroup operation returned by the service.
- Throws:
UserGroupNotFoundException- The user group was not found or does not existUserNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
purchaseReservedCacheNodesOffering
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.
- Parameters:
purchaseReservedCacheNodesOfferingRequest- Represents the input of aPurchaseReservedCacheNodesOfferingoperation.- Returns:
- Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
purchaseReservedCacheNodesOffering
default PurchaseReservedCacheNodesOfferingResponse purchaseReservedCacheNodesOffering(Consumer<PurchaseReservedCacheNodesOfferingRequest.Builder> purchaseReservedCacheNodesOfferingRequest) throws ReservedCacheNodesOfferingNotFoundException, ReservedCacheNodeAlreadyExistsException, ReservedCacheNodeQuotaExceededException, TagQuotaPerResourceExceededException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.
This is a convenience which creates an instance of the
PurchaseReservedCacheNodesOfferingRequest.Builderavoiding the need to create one manually viaPurchaseReservedCacheNodesOfferingRequest.builder()- Parameters:
purchaseReservedCacheNodesOfferingRequest- AConsumerthat will call methods onPurchaseReservedCacheNodesOfferingRequest.Builderto create a request. Represents the input of aPurchaseReservedCacheNodesOfferingoperation.- Returns:
- Result of the PurchaseReservedCacheNodesOffering operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
rebalanceSlotsInGlobalReplicationGroup
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
- Parameters:
rebalanceSlotsInGlobalReplicationGroupRequest-- Returns:
- Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
rebalanceSlotsInGlobalReplicationGroup
default RebalanceSlotsInGlobalReplicationGroupResponse rebalanceSlotsInGlobalReplicationGroup(Consumer<RebalanceSlotsInGlobalReplicationGroupRequest.Builder> rebalanceSlotsInGlobalReplicationGroupRequest) throws GlobalReplicationGroupNotFoundException, InvalidGlobalReplicationGroupStateException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
This is a convenience which creates an instance of the
RebalanceSlotsInGlobalReplicationGroupRequest.Builderavoiding the need to create one manually viaRebalanceSlotsInGlobalReplicationGroupRequest.builder()- Parameters:
rebalanceSlotsInGlobalReplicationGroupRequest- AConsumerthat will call methods onRebalanceSlotsInGlobalReplicationGroupRequest.Builderto create a request.- Returns:
- Result of the RebalanceSlotsInGlobalReplicationGroup operation returned by the service.
- Throws:
GlobalReplicationGroupNotFoundException- The Global datastore does not existInvalidGlobalReplicationGroupStateException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
rebootCacheCluster
default RebootCacheClusterResponse rebootCacheCluster(RebootCacheClusterRequest rebootCacheClusterRequest) throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached, 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 aRebootCacheClusteroperation.- Returns:
- Result of the RebootCacheCluster operation returned by the service.
- Throws:
InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
rebootCacheCluster
default RebootCacheClusterResponse rebootCacheCluster(Consumer<RebootCacheClusterRequest.Builder> rebootCacheClusterRequest) throws InvalidCacheClusterStateException, CacheClusterNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached, 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.Builderavoiding the need to create one manually viaRebootCacheClusterRequest.builder()- Parameters:
rebootCacheClusterRequest- AConsumerthat will call methods onRebootCacheClusterRequest.Builderto create a request. Represents the input of aRebootCacheClusteroperation.- Returns:
- Result of the RebootCacheCluster operation returned by the service.
- Throws:
InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Removes the tags identified by the
TagKeyslist 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 aRemoveTagsFromResourceoperation.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws CacheClusterNotFoundException, CacheParameterGroupNotFoundException, CacheSecurityGroupNotFoundException, CacheSubnetGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupNotFoundException, ReservedCacheNodeNotFoundException, SnapshotNotFoundException, UserNotFoundException, UserGroupNotFoundException, ServerlessCacheNotFoundException, InvalidServerlessCacheStateException, ServerlessCacheSnapshotNotFoundException, InvalidServerlessCacheSnapshotStateException, InvalidArnException, TagNotFoundException, AwsServiceException, SdkClientException, ElastiCacheException
Removes the tags identified by the
TagKeyslist 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.Builderavoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()- Parameters:
removeTagsFromResourceRequest- AConsumerthat will call methods onRemoveTagsFromResourceRequest.Builderto create a request. Represents the input of aRemoveTagsFromResourceoperation.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
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 theavailablestate.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 existServerlessCacheNotFoundException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
resetCacheParameterGroup
default ResetCacheParameterGroupResponse resetCacheParameterGroup(ResetCacheParameterGroupRequest resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the
ResetAllParametersandCacheParameterGroupNameparameters.- Parameters:
resetCacheParameterGroupRequest- Represents the input of aResetCacheParameterGroupoperation.- Returns:
- Result of the ResetCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
resetCacheParameterGroup
default ResetCacheParameterGroupResponse resetCacheParameterGroup(Consumer<ResetCacheParameterGroupRequest.Builder> resetCacheParameterGroupRequest) throws InvalidCacheParameterGroupStateException, CacheParameterGroupNotFoundException, InvalidParameterValueException, InvalidParameterCombinationException, InvalidGlobalReplicationGroupStateException, AwsServiceException, SdkClientException, ElastiCacheException
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the
ResetAllParametersandCacheParameterGroupNameparameters.
This is a convenience which creates an instance of the
ResetCacheParameterGroupRequest.Builderavoiding the need to create one manually viaResetCacheParameterGroupRequest.builder()- Parameters:
resetCacheParameterGroupRequest- AConsumerthat will call methods onResetCacheParameterGroupRequest.Builderto create a request. Represents the input of aResetCacheParameterGroupoperation.- Returns:
- Result of the ResetCacheParameterGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
revokeCacheSecurityGroupIngress
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest revokeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
- Parameters:
revokeCacheSecurityGroupIngressRequest- Represents the input of aRevokeCacheSecurityGroupIngressoperation.- Returns:
- Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
revokeCacheSecurityGroupIngress
default RevokeCacheSecurityGroupIngressResponse revokeCacheSecurityGroupIngress(Consumer<RevokeCacheSecurityGroupIngressRequest.Builder> revokeCacheSecurityGroupIngressRequest) throws CacheSecurityGroupNotFoundException, AuthorizationNotFoundException, InvalidCacheSecurityGroupStateException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
This is a convenience which creates an instance of the
RevokeCacheSecurityGroupIngressRequest.Builderavoiding the need to create one manually viaRevokeCacheSecurityGroupIngressRequest.builder()- Parameters:
revokeCacheSecurityGroupIngressRequest- AConsumerthat will call methods onRevokeCacheSecurityGroupIngressRequest.Builderto create a request. Represents the input of aRevokeCacheSecurityGroupIngressoperation.- Returns:
- Result of the RevokeCacheSecurityGroupIngress operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startMigration
default StartMigrationResponse startMigration(StartMigrationRequest startMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Start the migration of data.
- Parameters:
startMigrationRequest-- Returns:
- Result of the StartMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
startMigration
default StartMigrationResponse startMigration(Consumer<StartMigrationRequest.Builder> startMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Start the migration of data.
This is a convenience which creates an instance of the
StartMigrationRequest.Builderavoiding the need to create one manually viaStartMigrationRequest.builder()- Parameters:
startMigrationRequest- AConsumerthat will call methods onStartMigrationRequest.Builderto create a request.- Returns:
- Result of the StartMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
testFailover
default TestFailoverResponse testFailover(TestFailoverRequest testFailoverRequest) throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException, TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Represents the input of a
TestFailoveroperation 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:
-
Replication group message:
Test Failover API called for node group <node-group-id> -
Cache cluster message:
Failover from primary node <primary-node-id> to replica node <node-id> completed -
Replication group message:
Failover from primary node <primary-node-id> to replica node <node-id> completed -
Cache cluster message:
Recovering cache nodes <node-id> -
Cache cluster message:
Finished recovery for cache nodes <node-id>
For more information see:
-
Viewing ElastiCache Events in the ElastiCache User Guide
-
DescribeEvents in the ElastiCache API Reference
-
Also see, Testing Multi-AZ in the ElastiCache User Guide.
- Parameters:
testFailoverRequest-- Returns:
- Result of the TestFailover operation returned by the service.
- Throws:
ApiCallRateForCustomerExceededException- The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.NodeGroupNotFoundException- The node group specified by theNodeGroupIdparameter could not be found. Please verify that the node group exists and that you spelled theNodeGroupIdvalue correctly.ReplicationGroupNotFoundException- The specified replication group does not exist.TestFailoverNotAvailableException- TheTestFailoveraction 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
testFailover
default TestFailoverResponse testFailover(Consumer<TestFailoverRequest.Builder> testFailoverRequest) throws ApiCallRateForCustomerExceededException, InvalidCacheClusterStateException, InvalidReplicationGroupStateException, NodeGroupNotFoundException, ReplicationGroupNotFoundException, TestFailoverNotAvailableException, InvalidKmsKeyException, InvalidParameterValueException, InvalidParameterCombinationException, AwsServiceException, SdkClientException, ElastiCacheException
Represents the input of a
TestFailoveroperation 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:
-
Replication group message:
Test Failover API called for node group <node-group-id> -
Cache cluster message:
Failover from primary node <primary-node-id> to replica node <node-id> completed -
Replication group message:
Failover from primary node <primary-node-id> to replica node <node-id> completed -
Cache cluster message:
Recovering cache nodes <node-id> -
Cache cluster message:
Finished recovery for cache nodes <node-id>
For more information see:
-
Viewing ElastiCache Events in the ElastiCache User Guide
-
DescribeEvents in the ElastiCache API Reference
-
Also see, Testing Multi-AZ in the ElastiCache User Guide.
This is a convenience which creates an instance of the
TestFailoverRequest.Builderavoiding the need to create one manually viaTestFailoverRequest.builder()- Parameters:
testFailoverRequest- AConsumerthat will call methods onTestFailoverRequest.Builderto create a request.- Returns:
- Result of the TestFailover operation returned by the service.
- Throws:
ApiCallRateForCustomerExceededException- The customer has exceeded the allowed rate of API calls.InvalidCacheClusterStateException- The requested cluster is not in theavailablestate.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.NodeGroupNotFoundException- The node group specified by theNodeGroupIdparameter could not be found. Please verify that the node group exists and that you spelled theNodeGroupIdvalue correctly.ReplicationGroupNotFoundException- The specified replication group does not exist.TestFailoverNotAvailableException- TheTestFailoveraction 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
testMigration
default TestMigrationResponse testMigration(TestMigrationRequest testMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Async API to test connection between source and target replication group.
- Parameters:
testMigrationRequest-- Returns:
- Result of the TestMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
testMigration
default TestMigrationResponse testMigration(Consumer<TestMigrationRequest.Builder> testMigrationRequest) throws ReplicationGroupNotFoundException, InvalidReplicationGroupStateException, ReplicationGroupAlreadyUnderMigrationException, InvalidParameterValueException, AwsServiceException, SdkClientException, ElastiCacheException
Async API to test connection between source and target replication group.
This is a convenience which creates an instance of the
TestMigrationRequest.Builderavoiding the need to create one manually viaTestMigrationRequest.builder()- Parameters:
testMigrationRequest- AConsumerthat will call methods onTestMigrationRequest.Builderto create a request.- Returns:
- Result of the TestMigration operation returned by the service.
- Throws:
ReplicationGroupNotFoundException- The specified replication group does not exist.InvalidReplicationGroupStateException- The requested replication group is not in theavailablestate.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.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default ElastiCacheWaiter waiter()
Create an instance ofElastiCacheWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ElastiCacheWaiter
-
create
static ElastiCacheClient create()
Create aElastiCacheClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ElastiCacheClientBuilder builder()
Create a builder that can be used to configure and create aElastiCacheClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ElastiCacheServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-