Interface MemoryDbAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchUpdateCluster
(Consumer<BatchUpdateClusterRequest.Builder> batchUpdateClusterRequest) Apply the service update to a list of clusters supplied.batchUpdateCluster
(BatchUpdateClusterRequest batchUpdateClusterRequest) Apply the service update to a list of clusters supplied.static MemoryDbAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aMemoryDbAsyncClient
.default CompletableFuture
<CopySnapshotResponse> copySnapshot
(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) Makes a copy of an existing snapshot.default CompletableFuture
<CopySnapshotResponse> copySnapshot
(CopySnapshotRequest copySnapshotRequest) Makes a copy of an existing snapshot.static MemoryDbAsyncClient
create()
Create aMemoryDbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAclResponse> createACL
(Consumer<CreateAclRequest.Builder> createAclRequest) Creates an Access Control List.default CompletableFuture
<CreateAclResponse> createACL
(CreateAclRequest createAclRequest) Creates an Access Control List.default CompletableFuture
<CreateClusterResponse> createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a cluster.default CompletableFuture
<CreateClusterResponse> createCluster
(CreateClusterRequest createClusterRequest) Creates a cluster.createParameterGroup
(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest) Creates a new MemoryDB parameter group.createParameterGroup
(CreateParameterGroupRequest createParameterGroupRequest) Creates a new MemoryDB parameter group.default CompletableFuture
<CreateSnapshotResponse> createSnapshot
(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) Creates a copy of an entire cluster at a specific moment in time.default CompletableFuture
<CreateSnapshotResponse> createSnapshot
(CreateSnapshotRequest createSnapshotRequest) Creates a copy of an entire cluster at a specific moment in time.createSubnetGroup
(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest) Creates a subnet group.createSubnetGroup
(CreateSubnetGroupRequest createSubnetGroupRequest) Creates a subnet group.default CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a MemoryDB user.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates a MemoryDB user.default CompletableFuture
<DeleteAclResponse> deleteACL
(Consumer<DeleteAclRequest.Builder> deleteAclRequest) Deletes an Access Control List.default CompletableFuture
<DeleteAclResponse> deleteACL
(DeleteAclRequest deleteAclRequest) Deletes an Access Control List.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes a cluster.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes a cluster.deleteParameterGroup
(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest) Deletes the specified parameter group.deleteParameterGroup
(DeleteParameterGroupRequest deleteParameterGroupRequest) Deletes the specified parameter group.default CompletableFuture
<DeleteSnapshotResponse> deleteSnapshot
(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) Deletes an existing snapshot.default CompletableFuture
<DeleteSnapshotResponse> deleteSnapshot
(DeleteSnapshotRequest deleteSnapshotRequest) Deletes an existing snapshot.deleteSubnetGroup
(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest) Deletes a subnet group.deleteSubnetGroup
(DeleteSubnetGroupRequest deleteSubnetGroupRequest) Deletes a subnet group.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes a user.default CompletableFuture
<DescribeAcLsResponse> describeACLs
(Consumer<DescribeAcLsRequest.Builder> describeAcLsRequest) Returns a list of ACLsdefault CompletableFuture
<DescribeAcLsResponse> describeACLs
(DescribeAcLsRequest describeAcLsRequest) Returns a list of ACLsdefault DescribeACLsPublisher
describeACLsPaginator
(Consumer<DescribeAcLsRequest.Builder> describeAcLsRequest) This is a variant ofdescribeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation.default DescribeACLsPublisher
describeACLsPaginator
(DescribeAcLsRequest describeAcLsRequest) This is a variant ofdescribeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation.describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.describeClusters
(DescribeClustersRequest describeClustersRequest) Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.default DescribeClustersPublisher
describeClustersPaginator
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation.default DescribeClustersPublisher
describeClustersPaginator
(DescribeClustersRequest describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation.describeEngineVersions
(Consumer<DescribeEngineVersionsRequest.Builder> describeEngineVersionsRequest) Returns a list of the available Redis engine versions.describeEngineVersions
(DescribeEngineVersionsRequest describeEngineVersionsRequest) Returns a list of the available Redis engine versions.default DescribeEngineVersionsPublisher
describeEngineVersionsPaginator
(Consumer<DescribeEngineVersionsRequest.Builder> describeEngineVersionsRequest) This is a variant ofdescribeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation.default DescribeEngineVersionsPublisher
describeEngineVersionsPaginator
(DescribeEngineVersionsRequest describeEngineVersionsRequest) This is a variant ofdescribeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation.default CompletableFuture
<DescribeEventsResponse> describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to clusters, security groups, and parameter groups.default CompletableFuture
<DescribeEventsResponse> describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to clusters, security groups, and parameter groups.default DescribeEventsPublisher
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation.default DescribeEventsPublisher
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation.describeParameterGroups
(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) Returns a list of parameter group descriptions.describeParameterGroups
(DescribeParameterGroupsRequest describeParameterGroupsRequest) Returns a list of parameter group descriptions.default DescribeParameterGroupsPublisher
describeParameterGroupsPaginator
(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) This is a variant ofdescribeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation.default DescribeParameterGroupsPublisher
describeParameterGroupsPaginator
(DescribeParameterGroupsRequest describeParameterGroupsRequest) This is a variant ofdescribeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation.describeParameters
(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) Returns the detailed parameter list for a particular parameter group.describeParameters
(DescribeParametersRequest describeParametersRequest) Returns the detailed parameter list for a particular parameter group.default DescribeParametersPublisher
describeParametersPaginator
(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) This is a variant ofdescribeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation.default DescribeParametersPublisher
describeParametersPaginator
(DescribeParametersRequest describeParametersRequest) This is a variant ofdescribeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation.describeReservedNodes
(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) Returns information about reserved nodes for this account, or about a specified reserved node.describeReservedNodes
(DescribeReservedNodesRequest describeReservedNodesRequest) Returns information about reserved nodes for this account, or about a specified reserved node.describeReservedNodesOfferings
(Consumer<DescribeReservedNodesOfferingsRequest.Builder> describeReservedNodesOfferingsRequest) Lists available reserved node offerings.describeReservedNodesOfferings
(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest) Lists available reserved node offerings.describeReservedNodesOfferingsPaginator
(Consumer<DescribeReservedNodesOfferingsRequest.Builder> describeReservedNodesOfferingsRequest) This is a variant ofdescribeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation.describeReservedNodesOfferingsPaginator
(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest) This is a variant ofdescribeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation.default DescribeReservedNodesPublisher
describeReservedNodesPaginator
(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation.default DescribeReservedNodesPublisher
describeReservedNodesPaginator
(DescribeReservedNodesRequest describeReservedNodesRequest) This is a variant ofdescribeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation.describeServiceUpdates
(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) Returns details of the service updatesdescribeServiceUpdates
(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) Returns details of the service updatesdefault DescribeServiceUpdatesPublisher
describeServiceUpdatesPaginator
(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) This is a variant ofdescribeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation.default DescribeServiceUpdatesPublisher
describeServiceUpdatesPaginator
(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) This is a variant ofdescribeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation.describeSnapshots
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) Returns information about cluster snapshots.describeSnapshots
(DescribeSnapshotsRequest describeSnapshotsRequest) Returns information about cluster snapshots.default DescribeSnapshotsPublisher
describeSnapshotsPaginator
(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation.default DescribeSnapshotsPublisher
describeSnapshotsPaginator
(DescribeSnapshotsRequest describeSnapshotsRequest) This is a variant ofdescribeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation.describeSubnetGroups
(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) Returns a list of subnet group descriptions.describeSubnetGroups
(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) Returns a list of subnet group descriptions.default DescribeSubnetGroupsPublisher
describeSubnetGroupsPaginator
(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) This is a variant ofdescribeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation.default DescribeSubnetGroupsPublisher
describeSubnetGroupsPaginator
(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) This is a variant ofdescribeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation.default CompletableFuture
<DescribeUsersResponse> describeUsers
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Returns a list of users.default CompletableFuture
<DescribeUsersResponse> describeUsers
(DescribeUsersRequest describeUsersRequest) Returns a list of users.default DescribeUsersPublisher
describeUsersPaginator
(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation.default DescribeUsersPublisher
describeUsersPaginator
(DescribeUsersRequest describeUsersRequest) This is a variant ofdescribeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation.default CompletableFuture
<FailoverShardResponse> failoverShard
(Consumer<FailoverShardRequest.Builder> failoverShardRequest) Used to failover a shard.default CompletableFuture
<FailoverShardResponse> failoverShard
(FailoverShardRequest failoverShardRequest) Used to failover a shard.listAllowedNodeTypeUpdates
(Consumer<ListAllowedNodeTypeUpdatesRequest.Builder> listAllowedNodeTypeUpdatesRequest) Lists all available node types that you can scale to from your cluster's current node type.listAllowedNodeTypeUpdates
(ListAllowedNodeTypeUpdatesRequest listAllowedNodeTypeUpdatesRequest) Lists all available node types that you can scale to from your cluster's current node type.default CompletableFuture
<ListTagsResponse> listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Lists all tags currently on a named resource.default CompletableFuture
<ListTagsResponse> listTags
(ListTagsRequest listTagsRequest) Lists all tags currently on a named resource.purchaseReservedNodesOffering
(Consumer<PurchaseReservedNodesOfferingRequest.Builder> purchaseReservedNodesOfferingRequest) Allows you to purchase a reserved node offering.purchaseReservedNodesOffering
(PurchaseReservedNodesOfferingRequest purchaseReservedNodesOfferingRequest) Allows you to purchase a reserved node offering.resetParameterGroup
(Consumer<ResetParameterGroupRequest.Builder> resetParameterGroupRequest) Modifies the parameters of a parameter group to the engine or system default value.resetParameterGroup
(ResetParameterGroupRequest resetParameterGroupRequest) Modifies the parameters of a parameter group to the engine or system default value.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) A tag is a key-value pair where the key and value are case-sensitive.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) A tag is a key-value pair where the key and value are case-sensitive.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Use this operation to remove tags on a resourcedefault CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Use this operation to remove tags on a resourcedefault CompletableFuture
<UpdateAclResponse> updateACL
(Consumer<UpdateAclRequest.Builder> updateAclRequest) Changes the list of users that belong to the Access Control List.default CompletableFuture
<UpdateAclResponse> updateACL
(UpdateAclRequest updateAclRequest) Changes the list of users that belong to the Access Control List.default CompletableFuture
<UpdateClusterResponse> updateCluster
(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) Modifies the settings for a cluster.default CompletableFuture
<UpdateClusterResponse> updateCluster
(UpdateClusterRequest updateClusterRequest) Modifies the settings for a cluster.updateParameterGroup
(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest) Updates the parameters of a parameter group.updateParameterGroup
(UpdateParameterGroupRequest updateParameterGroupRequest) Updates the parameters of a parameter group.updateSubnetGroup
(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest) Updates a subnet group.updateSubnetGroup
(UpdateSubnetGroupRequest updateSubnetGroupRequest) Updates a subnet group.default CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Changes user password(s) and/or access string.default CompletableFuture
<UpdateUserResponse> updateUser
(UpdateUserRequest updateUserRequest) Changes user password(s) and/or access string.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchUpdateCluster
default CompletableFuture<BatchUpdateClusterResponse> batchUpdateCluster(BatchUpdateClusterRequest batchUpdateClusterRequest) Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
- Parameters:
batchUpdateClusterRequest
-- Returns:
- A Java Future containing the result of the BatchUpdateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceUpdateNotFoundException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateCluster
default CompletableFuture<BatchUpdateClusterResponse> batchUpdateCluster(Consumer<BatchUpdateClusterRequest.Builder> batchUpdateClusterRequest) Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
This is a convenience which creates an instance of the
BatchUpdateClusterRequest.Builder
avoiding the need to create one manually viaBatchUpdateClusterRequest.builder()
- Parameters:
batchUpdateClusterRequest
- AConsumer
that will call methods onBatchUpdateClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceUpdateNotFoundException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copySnapshot
default CompletableFuture<CopySnapshotResponse> copySnapshot(CopySnapshotRequest copySnapshotRequest) Makes a copy of an existing snapshot.
- Parameters:
copySnapshotRequest
-- Returns:
- A Java Future containing the result of the CopySnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotAlreadyExistsException
- SnapshotNotFoundException
- SnapshotQuotaExceededException
- InvalidSnapshotStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copySnapshot
default CompletableFuture<CopySnapshotResponse> copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) Makes a copy of an existing snapshot.
This is a convenience which creates an instance of the
CopySnapshotRequest.Builder
avoiding the need to create one manually viaCopySnapshotRequest.builder()
- Parameters:
copySnapshotRequest
- AConsumer
that will call methods onCopySnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopySnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotAlreadyExistsException
- SnapshotNotFoundException
- SnapshotQuotaExceededException
- InvalidSnapshotStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createACL
Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
- Parameters:
createAclRequest
-- Returns:
- A Java Future containing the result of the CreateACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- DuplicateUserNameException
- AclAlreadyExistsException
- DefaultUserRequiredException
- AclQuotaExceededException
- InvalidParameterValueException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createACL
default CompletableFuture<CreateAclResponse> createACL(Consumer<CreateAclRequest.Builder> createAclRequest) Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
This is a convenience which creates an instance of the
CreateAclRequest.Builder
avoiding the need to create one manually viaCreateAclRequest.builder()
- Parameters:
createAclRequest
- AConsumer
that will call methods onCreateAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- DuplicateUserNameException
- AclAlreadyExistsException
- DefaultUserRequiredException
- AclQuotaExceededException
- InvalidParameterValueException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest) Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
- Parameters:
createClusterRequest
-- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterAlreadyExistsException
- SubnetGroupNotFoundException
- ClusterQuotaForCustomerExceededException
- NodeQuotaForClusterExceededException
- NodeQuotaForCustomerExceededException
- ParameterGroupNotFoundException
- InsufficientClusterCapacityException
- InvalidVpcNetworkStateException
- ServiceLinkedRoleNotFoundException
- ShardsPerClusterQuotaExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- InvalidCredentialsException
- TagQuotaPerResourceExceededException
- AclNotFoundException
- InvalidAclStateException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterAlreadyExistsException
- SubnetGroupNotFoundException
- ClusterQuotaForCustomerExceededException
- NodeQuotaForClusterExceededException
- NodeQuotaForCustomerExceededException
- ParameterGroupNotFoundException
- InsufficientClusterCapacityException
- InvalidVpcNetworkStateException
- ServiceLinkedRoleNotFoundException
- ShardsPerClusterQuotaExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- InvalidCredentialsException
- TagQuotaPerResourceExceededException
- AclNotFoundException
- InvalidAclStateException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createParameterGroup
default CompletableFuture<CreateParameterGroupResponse> createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest) Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
- Parameters:
createParameterGroupRequest
-- Returns:
- A Java Future containing the result of the CreateParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupQuotaExceededException
- ParameterGroupAlreadyExistsException
- InvalidParameterGroupStateException
- ServiceLinkedRoleNotFoundException
- TagQuotaPerResourceExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createParameterGroup
default CompletableFuture<CreateParameterGroupResponse> createParameterGroup(Consumer<CreateParameterGroupRequest.Builder> createParameterGroupRequest) Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
This is a convenience which creates an instance of the
CreateParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateParameterGroupRequest.builder()
- Parameters:
createParameterGroupRequest
- AConsumer
that will call methods onCreateParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupQuotaExceededException
- ParameterGroupAlreadyExistsException
- InvalidParameterGroupStateException
- ServiceLinkedRoleNotFoundException
- TagQuotaPerResourceExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSnapshot
default CompletableFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest createSnapshotRequest) Creates a copy of an entire cluster at a specific moment in time.
- Parameters:
createSnapshotRequest
-- Returns:
- A Java Future containing the result of the CreateSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotAlreadyExistsException
- ClusterNotFoundException
- InvalidClusterStateException
- SnapshotQuotaExceededException
- ServiceLinkedRoleNotFoundException
- InvalidParameterCombinationException
- InvalidParameterValueException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSnapshot
default CompletableFuture<CreateSnapshotResponse> createSnapshot(Consumer<CreateSnapshotRequest.Builder> createSnapshotRequest) Creates a copy of an entire cluster at a specific moment in time.
This is a convenience which creates an instance of the
CreateSnapshotRequest.Builder
avoiding the need to create one manually viaCreateSnapshotRequest.builder()
- Parameters:
createSnapshotRequest
- AConsumer
that will call methods onCreateSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotAlreadyExistsException
- ClusterNotFoundException
- InvalidClusterStateException
- SnapshotQuotaExceededException
- ServiceLinkedRoleNotFoundException
- InvalidParameterCombinationException
- InvalidParameterValueException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSubnetGroup
default CompletableFuture<CreateSubnetGroupResponse> createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest) Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
- Parameters:
createSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the CreateSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupAlreadyExistsException
- SubnetGroupQuotaExceededException
- SubnetQuotaExceededException
- InvalidSubnetException
- ServiceLinkedRoleNotFoundException
- SubnetNotAllowedException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSubnetGroup
default CompletableFuture<CreateSubnetGroupResponse> createSubnetGroup(Consumer<CreateSubnetGroupRequest.Builder> createSubnetGroupRequest) Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
This is a convenience which creates an instance of the
CreateSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateSubnetGroupRequest.builder()
- Parameters:
createSubnetGroupRequest
- AConsumer
that will call methods onCreateSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupAlreadyExistsException
- SubnetGroupQuotaExceededException
- SubnetQuotaExceededException
- InvalidSubnetException
- ServiceLinkedRoleNotFoundException
- SubnetNotAllowedException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
- Parameters:
createUserRequest
-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserAlreadyExistsException
- UserQuotaExceededException
- DuplicateUserNameException
- InvalidParameterValueException
- InvalidParameterCombinationException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserAlreadyExistsException
- UserQuotaExceededException
- DuplicateUserNameException
- InvalidParameterValueException
- InvalidParameterCombinationException
- TagQuotaPerResourceExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteACL
Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
- Parameters:
deleteAclRequest
-- Returns:
- A Java Future containing the result of the DeleteACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidAclStateException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteACL
default CompletableFuture<DeleteAclResponse> deleteACL(Consumer<DeleteAclRequest.Builder> deleteAclRequest) Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
This is a convenience which creates an instance of the
DeleteAclRequest.Builder
avoiding the need to create one manually viaDeleteAclRequest.builder()
- Parameters:
deleteAclRequest
- AConsumer
that will call methods onDeleteAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidAclStateException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes a cluster. It also deletes all associated nodes and node endpoints
- Parameters:
deleteClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- SnapshotAlreadyExistsException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes a cluster. It also deletes all associated nodes and node endpoints
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- SnapshotAlreadyExistsException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteParameterGroup
default CompletableFuture<DeleteParameterGroupResponse> deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest) Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
- Parameters:
deleteParameterGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterGroupStateException
- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteParameterGroup
default CompletableFuture<DeleteParameterGroupResponse> deleteParameterGroup(Consumer<DeleteParameterGroupRequest.Builder> deleteParameterGroupRequest) Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
This is a convenience which creates an instance of the
DeleteParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteParameterGroupRequest.builder()
- Parameters:
deleteParameterGroupRequest
- AConsumer
that will call methods onDeleteParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterGroupStateException
- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshot
default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest) Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
- Parameters:
deleteSnapshotRequest
-- Returns:
- A Java Future containing the result of the DeleteSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- InvalidSnapshotStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSnapshot
default CompletableFuture<DeleteSnapshotResponse> deleteSnapshot(Consumer<DeleteSnapshotRequest.Builder> deleteSnapshotRequest) Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This is a convenience which creates an instance of the
DeleteSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteSnapshotRequest.builder()
- Parameters:
deleteSnapshotRequest
- AConsumer
that will call methods onDeleteSnapshotRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- InvalidSnapshotStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSubnetGroup
default CompletableFuture<DeleteSubnetGroupResponse> deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest) Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
- Parameters:
deleteSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupInUseException
- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSubnetGroup
default CompletableFuture<DeleteSubnetGroupResponse> deleteSubnetGroup(Consumer<DeleteSubnetGroupRequest.Builder> deleteSubnetGroupRequest) Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
This is a convenience which creates an instance of the
DeleteSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteSubnetGroupRequest.builder()
- Parameters:
deleteSubnetGroupRequest
- AConsumer
that will call methods onDeleteSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupInUseException
- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidUserStateException
- UserNotFoundException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidUserStateException
- UserNotFoundException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeACLs
default CompletableFuture<DescribeAcLsResponse> describeACLs(DescribeAcLsRequest describeAcLsRequest) Returns a list of ACLs
- Parameters:
describeAcLsRequest
-- Returns:
- A Java Future containing the result of the DescribeACLs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeACLs
default CompletableFuture<DescribeAcLsResponse> describeACLs(Consumer<DescribeAcLsRequest.Builder> describeAcLsRequest) Returns a list of ACLs
This is a convenience which creates an instance of the
DescribeAcLsRequest.Builder
avoiding the need to create one manually viaDescribeAcLsRequest.builder()
- Parameters:
describeAcLsRequest
- AConsumer
that will call methods onDescribeAcLsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeACLs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeACLsPaginator
This is a variant of
describeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeACLsPublisher publisher = client.describeACLsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeACLsPublisher publisher = client.describeACLsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeAcLsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeAcLsResponse response) { //... }; });
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
describeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation.- Parameters:
describeAcLsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeACLsPaginator
default DescribeACLsPublisher describeACLsPaginator(Consumer<DescribeAcLsRequest.Builder> describeAcLsRequest) This is a variant of
describeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeACLsPublisher publisher = client.describeACLsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeACLsPublisher publisher = client.describeACLsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeAcLsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeAcLsResponse response) { //... }; });
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
describeACLs(software.amazon.awssdk.services.memorydb.model.DescribeAcLsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAcLsRequest.Builder
avoiding the need to create one manually viaDescribeAcLsRequest.builder()
- Parameters:
describeAcLsRequest
- AConsumer
that will call methods onDescribeAcLsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest) Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
- Parameters:
describeClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(DescribeClustersRequest describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeClustersResponse response) { //... }; });
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
describeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation.- Parameters:
describeClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeClustersResponse response) { //... }; });
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
describeClusters(software.amazon.awssdk.services.memorydb.model.DescribeClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineVersions
default CompletableFuture<DescribeEngineVersionsResponse> describeEngineVersions(DescribeEngineVersionsRequest describeEngineVersionsRequest) Returns a list of the available Redis engine versions.
- Parameters:
describeEngineVersionsRequest
-- Returns:
- A Java Future containing the result of the DescribeEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineVersions
default CompletableFuture<DescribeEngineVersionsResponse> describeEngineVersions(Consumer<DescribeEngineVersionsRequest.Builder> describeEngineVersionsRequest) Returns a list of the available Redis engine versions.
This is a convenience which creates an instance of the
DescribeEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeEngineVersionsRequest.builder()
- Parameters:
describeEngineVersionsRequest
- AConsumer
that will call methods onDescribeEngineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineVersionsPaginator
default DescribeEngineVersionsPublisher describeEngineVersionsPaginator(DescribeEngineVersionsRequest describeEngineVersionsRequest) This is a variant of
describeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeEngineVersionsPublisher publisher = client.describeEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeEngineVersionsPublisher publisher = client.describeEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsResponse response) { //... }; });
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
describeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation.- Parameters:
describeEngineVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEngineVersionsPaginator
default DescribeEngineVersionsPublisher describeEngineVersionsPaginator(Consumer<DescribeEngineVersionsRequest.Builder> describeEngineVersionsRequest) This is a variant of
describeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeEngineVersionsPublisher publisher = client.describeEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeEngineVersionsPublisher publisher = client.describeEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsResponse response) { //... }; });
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
describeEngineVersions(software.amazon.awssdk.services.memorydb.model.DescribeEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeEngineVersionsRequest.builder()
- Parameters:
describeEngineVersionsRequest
- AConsumer
that will call methods onDescribeEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or 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
-- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEvents
default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeEventsResponse response) { //... }; });
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
describeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEventsPaginator
default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant of
describeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeEventsResponse response) { //... }; });
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
describeEvents(software.amazon.awssdk.services.memorydb.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameterGroups
default CompletableFuture<DescribeParameterGroupsResponse> describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest) Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
- Parameters:
describeParameterGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameterGroups
default CompletableFuture<DescribeParameterGroupsResponse> describeParameterGroups(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
This is a convenience which creates an instance of the
DescribeParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeParameterGroupsRequest.builder()
- Parameters:
describeParameterGroupsRequest
- AConsumer
that will call methods onDescribeParameterGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameterGroupsPaginator
default DescribeParameterGroupsPublisher describeParameterGroupsPaginator(DescribeParameterGroupsRequest describeParameterGroupsRequest) This is a variant of
describeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeParameterGroupsPublisher publisher = client.describeParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeParameterGroupsPublisher publisher = client.describeParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsResponse response) { //... }; });
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
describeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation.- Parameters:
describeParameterGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameterGroupsPaginator
default DescribeParameterGroupsPublisher describeParameterGroupsPaginator(Consumer<DescribeParameterGroupsRequest.Builder> describeParameterGroupsRequest) This is a variant of
describeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeParameterGroupsPublisher publisher = client.describeParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeParameterGroupsPublisher publisher = client.describeParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsResponse response) { //... }; });
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
describeParameterGroups(software.amazon.awssdk.services.memorydb.model.DescribeParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeParameterGroupsRequest.builder()
- Parameters:
describeParameterGroupsRequest
- AConsumer
that will call methods onDescribeParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameters
default CompletableFuture<DescribeParametersResponse> describeParameters(DescribeParametersRequest describeParametersRequest) Returns the detailed parameter list for a particular parameter group.
- Parameters:
describeParametersRequest
-- Returns:
- A Java Future containing the result of the DescribeParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParameters
default CompletableFuture<DescribeParametersResponse> describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) Returns the detailed parameter list for a particular parameter group.
This is a convenience which creates an instance of the
DescribeParametersRequest.Builder
avoiding the need to create one manually viaDescribeParametersRequest.builder()
- Parameters:
describeParametersRequest
- AConsumer
that will call methods onDescribeParametersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeParameters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParametersPaginator
default DescribeParametersPublisher describeParametersPaginator(DescribeParametersRequest describeParametersRequest) This is a variant of
describeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeParametersResponse response) { //... }; });
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
describeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation.- Parameters:
describeParametersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeParametersPaginator
default DescribeParametersPublisher describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) This is a variant of
describeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeParametersPublisher publisher = client.describeParametersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeParametersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeParametersResponse response) { //... }; });
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
describeParameters(software.amazon.awssdk.services.memorydb.model.DescribeParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeParametersRequest.Builder
avoiding the need to create one manually viaDescribeParametersRequest.builder()
- Parameters:
describeParametersRequest
- AConsumer
that will call methods onDescribeParametersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodes
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(DescribeReservedNodesRequest describeReservedNodesRequest) Returns information about reserved nodes for this account, or about a specified reserved node.
- Parameters:
describeReservedNodesRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The requested node does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodes
default CompletableFuture<DescribeReservedNodesResponse> describeReservedNodes(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) Returns information about reserved nodes for this account, or about a specified reserved node.
This is a convenience which creates an instance of the
DescribeReservedNodesRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The requested node does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesOfferings
default CompletableFuture<DescribeReservedNodesOfferingsResponse> describeReservedNodesOfferings(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest) Lists available reserved node offerings.
- Parameters:
describeReservedNodesOfferingsRequest
-- Returns:
- A Java Future containing the result of the DescribeReservedNodesOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesOfferings
default CompletableFuture<DescribeReservedNodesOfferingsResponse> describeReservedNodesOfferings(Consumer<DescribeReservedNodesOfferingsRequest.Builder> describeReservedNodesOfferingsRequest) Lists available reserved node offerings.
This is a convenience which creates an instance of the
DescribeReservedNodesOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesOfferingsRequest.builder()
- Parameters:
describeReservedNodesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodesOfferingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeReservedNodesOfferings operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesOfferingsPaginator
default DescribeReservedNodesOfferingsPublisher describeReservedNodesOfferingsPaginator(DescribeReservedNodesOfferingsRequest describeReservedNodesOfferingsRequest) This is a variant of
describeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesOfferingsPublisher publisher = client.describeReservedNodesOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesOfferingsPublisher publisher = client.describeReservedNodesOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsResponse response) { //... }; });
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
describeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation.- Parameters:
describeReservedNodesOfferingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesOfferingsPaginator
default DescribeReservedNodesOfferingsPublisher describeReservedNodesOfferingsPaginator(Consumer<DescribeReservedNodesOfferingsRequest.Builder> describeReservedNodesOfferingsRequest) This is a variant of
describeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesOfferingsPublisher publisher = client.describeReservedNodesOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesOfferingsPublisher publisher = client.describeReservedNodesOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsResponse response) { //... }; });
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
describeReservedNodesOfferings(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesOfferingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedNodesOfferingsRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesOfferingsRequest.builder()
- Parameters:
describeReservedNodesOfferingsRequest
- AConsumer
that will call methods onDescribeReservedNodesOfferingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesPublisher describeReservedNodesPaginator(DescribeReservedNodesRequest describeReservedNodesRequest) This is a variant of
describeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesResponse response) { //... }; });
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
describeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation.- Parameters:
describeReservedNodesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The requested node does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeReservedNodesPaginator
default DescribeReservedNodesPublisher describeReservedNodesPaginator(Consumer<DescribeReservedNodesRequest.Builder> describeReservedNodesRequest) This is a variant of
describeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeReservedNodesPublisher publisher = client.describeReservedNodesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesResponse response) { //... }; });
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
describeReservedNodes(software.amazon.awssdk.services.memorydb.model.DescribeReservedNodesRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedNodesRequest.Builder
avoiding the need to create one manually viaDescribeReservedNodesRequest.builder()
- Parameters:
describeReservedNodesRequest
- AConsumer
that will call methods onDescribeReservedNodesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodeNotFoundException The requested node does not exist.
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServiceUpdates
default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) Returns details of the service updates
- Parameters:
describeServiceUpdatesRequest
-- Returns:
- A Java Future containing the result of the DescribeServiceUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServiceUpdates
default CompletableFuture<DescribeServiceUpdatesResponse> describeServiceUpdates(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) Returns details of the service updates
This is a convenience which creates an instance of the
DescribeServiceUpdatesRequest.Builder
avoiding the need to create one manually viaDescribeServiceUpdatesRequest.builder()
- Parameters:
describeServiceUpdatesRequest
- AConsumer
that will call methods onDescribeServiceUpdatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeServiceUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(DescribeServiceUpdatesRequest describeServiceUpdatesRequest) This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesResponse response) { //... }; });
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
describeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation.- Parameters:
describeServiceUpdatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeServiceUpdatesPaginator
default DescribeServiceUpdatesPublisher describeServiceUpdatesPaginator(Consumer<DescribeServiceUpdatesRequest.Builder> describeServiceUpdatesRequest) This is a variant of
describeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeServiceUpdatesPublisher publisher = client.describeServiceUpdatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesResponse response) { //... }; });
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
describeServiceUpdates(software.amazon.awssdk.services.memorydb.model.DescribeServiceUpdatesRequest)
operation.
This is a convenience which creates an instance of the
DescribeServiceUpdatesRequest.Builder
avoiding the need to create one manually viaDescribeServiceUpdatesRequest.builder()
- Parameters:
describeServiceUpdatesRequest
- AConsumer
that will call methods onDescribeServiceUpdatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshots
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(DescribeSnapshotsRequest describeSnapshotsRequest) Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
- Parameters:
describeSnapshotsRequest
-- Returns:
- A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshots
default CompletableFuture<DescribeSnapshotsResponse> describeSnapshots(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSnapshots operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsPublisher describeSnapshotsPaginator(DescribeSnapshotsRequest describeSnapshotsRequest) This is a variant of
describeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsResponse response) { //... }; });
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
describeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation.- Parameters:
describeSnapshotsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSnapshotsPaginator
default DescribeSnapshotsPublisher describeSnapshotsPaginator(Consumer<DescribeSnapshotsRequest.Builder> describeSnapshotsRequest) This is a variant of
describeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeSnapshotsPublisher publisher = client.describeSnapshotsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsResponse response) { //... }; });
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
describeSnapshots(software.amazon.awssdk.services.memorydb.model.DescribeSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeSnapshotsRequest.builder()
- Parameters:
describeSnapshotsRequest
- AConsumer
that will call methods onDescribeSnapshotsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SnapshotNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSubnetGroups
default CompletableFuture<DescribeSubnetGroupsResponse> describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
- Parameters:
describeSubnetGroupsRequest
-- Returns:
- A Java Future containing the result of the DescribeSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSubnetGroups
default CompletableFuture<DescribeSubnetGroupsResponse> describeSubnetGroups(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
This is a convenience which creates an instance of the
DescribeSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeSubnetGroupsRequest.builder()
- Parameters:
describeSubnetGroupsRequest
- AConsumer
that will call methods onDescribeSubnetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSubnetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSubnetGroupsPaginator
default DescribeSubnetGroupsPublisher describeSubnetGroupsPaginator(DescribeSubnetGroupsRequest describeSubnetGroupsRequest) This is a variant of
describeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeSubnetGroupsPublisher publisher = client.describeSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeSubnetGroupsPublisher publisher = client.describeSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsResponse response) { //... }; });
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
describeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation.- Parameters:
describeSubnetGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeSubnetGroupsPaginator
default DescribeSubnetGroupsPublisher describeSubnetGroupsPaginator(Consumer<DescribeSubnetGroupsRequest.Builder> describeSubnetGroupsRequest) This is a variant of
describeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeSubnetGroupsPublisher publisher = client.describeSubnetGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeSubnetGroupsPublisher publisher = client.describeSubnetGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsResponse response) { //... }; });
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
describeSubnetGroups(software.amazon.awssdk.services.memorydb.model.DescribeSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeSubnetGroupsRequest.builder()
- Parameters:
describeSubnetGroupsRequest
- AConsumer
that will call methods onDescribeSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsers
default CompletableFuture<DescribeUsersResponse> describeUsers(DescribeUsersRequest describeUsersRequest) Returns a list of users.
- Parameters:
describeUsersRequest
-- Returns:
- A Java Future containing the result of the DescribeUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsers
default CompletableFuture<DescribeUsersResponse> describeUsers(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) Returns a list of users.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsersPaginator
This is a variant of
describeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeUsersResponse response) { //... }; });
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
describeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation.- Parameters:
describeUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUsersPaginator
default DescribeUsersPublisher describeUsersPaginator(Consumer<DescribeUsersRequest.Builder> describeUsersRequest) This is a variant of
describeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.memorydb.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.memorydb.paginators.DescribeUsersPublisher publisher = client.describeUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.memorydb.model.DescribeUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.memorydb.model.DescribeUsersResponse response) { //... }; });
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
describeUsers(software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest)
operation.
This is a convenience which creates an instance of the
DescribeUsersRequest.Builder
avoiding the need to create one manually viaDescribeUsersRequest.builder()
- Parameters:
describeUsersRequest
- AConsumer
that will call methods onDescribeUsersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
failoverShard
default CompletableFuture<FailoverShardResponse> failoverShard(FailoverShardRequest failoverShardRequest) Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level 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.
- Parameters:
failoverShardRequest
-- Returns:
- A Java Future containing the result of the FailoverShard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApiCallRateForCustomerExceededException
- InvalidClusterStateException
- ShardNotFoundException
- ClusterNotFoundException
- TestFailoverNotAvailableException
- InvalidKmsKeyException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
failoverShard
default CompletableFuture<FailoverShardResponse> failoverShard(Consumer<FailoverShardRequest.Builder> failoverShardRequest) Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level 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.
This is a convenience which creates an instance of the
FailoverShardRequest.Builder
avoiding the need to create one manually viaFailoverShardRequest.builder()
- Parameters:
failoverShardRequest
- AConsumer
that will call methods onFailoverShardRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the FailoverShard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ApiCallRateForCustomerExceededException
- InvalidClusterStateException
- ShardNotFoundException
- ClusterNotFoundException
- TestFailoverNotAvailableException
- InvalidKmsKeyException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedNodeTypeUpdates
default CompletableFuture<ListAllowedNodeTypeUpdatesResponse> listAllowedNodeTypeUpdates(ListAllowedNodeTypeUpdatesRequest listAllowedNodeTypeUpdatesRequest) Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
- Parameters:
listAllowedNodeTypeUpdatesRequest
-- Returns:
- A Java Future containing the result of the ListAllowedNodeTypeUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterCombinationException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAllowedNodeTypeUpdates
default CompletableFuture<ListAllowedNodeTypeUpdatesResponse> listAllowedNodeTypeUpdates(Consumer<ListAllowedNodeTypeUpdatesRequest.Builder> listAllowedNodeTypeUpdatesRequest) Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
This is a convenience which creates an instance of the
ListAllowedNodeTypeUpdatesRequest.Builder
avoiding the need to create one manually viaListAllowedNodeTypeUpdatesRequest.builder()
- Parameters:
listAllowedNodeTypeUpdatesRequest
- AConsumer
that will call methods onListAllowedNodeTypeUpdatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAllowedNodeTypeUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterCombinationException
- InvalidParameterValueException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
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 your MemoryDB resources. For more information, see Tagging your MemoryDB resources
- Parameters:
listTagsRequest
-- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- SnapshotNotFoundException
- InvalidArnException
- ServiceLinkedRoleNotFoundException
- UserNotFoundException
- AclNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) 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 your MemoryDB resources. For more information, see Tagging your MemoryDB resources
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- SnapshotNotFoundException
- InvalidArnException
- ServiceLinkedRoleNotFoundException
- UserNotFoundException
- AclNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
purchaseReservedNodesOffering
default CompletableFuture<PurchaseReservedNodesOfferingResponse> purchaseReservedNodesOffering(PurchaseReservedNodesOfferingRequest purchaseReservedNodesOfferingRequest) Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
- Parameters:
purchaseReservedNodesOfferingRequest
-- Returns:
- A Java Future containing the result of the PurchaseReservedNodesOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ReservedNodeAlreadyExistsException You already have a reservation with the given identifier.
- ReservedNodeQuotaExceededException The request cannot be processed because it would exceed the user's node quota.
- ServiceLinkedRoleNotFoundException
- TagQuotaPerResourceExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
purchaseReservedNodesOffering
default CompletableFuture<PurchaseReservedNodesOfferingResponse> purchaseReservedNodesOffering(Consumer<PurchaseReservedNodesOfferingRequest.Builder> purchaseReservedNodesOfferingRequest) Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
This is a convenience which creates an instance of the
PurchaseReservedNodesOfferingRequest.Builder
avoiding the need to create one manually viaPurchaseReservedNodesOfferingRequest.builder()
- Parameters:
purchaseReservedNodesOfferingRequest
- AConsumer
that will call methods onPurchaseReservedNodesOfferingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PurchaseReservedNodesOffering operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ReservedNodesOfferingNotFoundException The requested node offering does not exist.
- ReservedNodeAlreadyExistsException You already have a reservation with the given identifier.
- ReservedNodeQuotaExceededException The request cannot be processed because it would exceed the user's node quota.
- ServiceLinkedRoleNotFoundException
- TagQuotaPerResourceExceededException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetParameterGroup
default CompletableFuture<ResetParameterGroupResponse> resetParameterGroup(ResetParameterGroupRequest resetParameterGroupRequest) Modifies the parameters of a 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 parameter group, specify the AllParameters and ParameterGroupName parameters.
- Parameters:
resetParameterGroupRequest
-- Returns:
- A Java Future containing the result of the ResetParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterGroupStateException
- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetParameterGroup
default CompletableFuture<ResetParameterGroupResponse> resetParameterGroup(Consumer<ResetParameterGroupRequest.Builder> resetParameterGroupRequest) Modifies the parameters of a 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 parameter group, specify the AllParameters and ParameterGroupName parameters.
This is a convenience which creates an instance of the
ResetParameterGroupRequest.Builder
avoiding the need to create one manually viaResetParameterGroupRequest.builder()
- Parameters:
resetParameterGroupRequest
- AConsumer
that will call methods onResetParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResetParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterGroupStateException
- ParameterGroupNotFoundException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your MemoryDB 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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- InvalidClusterStateException
- SnapshotNotFoundException
- UserNotFoundException
- AclNotFoundException
- TagQuotaPerResourceExceededException
- InvalidArnException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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 MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your MemoryDB 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- InvalidClusterStateException
- SnapshotNotFoundException
- UserNotFoundException
- AclNotFoundException
- TagQuotaPerResourceExceededException
- InvalidArnException
- ServiceLinkedRoleNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Use this operation to remove tags on a resource
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- SnapshotNotFoundException
- InvalidArnException
- TagNotFoundException
- ServiceLinkedRoleNotFoundException
- UserNotFoundException
- AclNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Use this operation to remove tags on a resource
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- ParameterGroupNotFoundException
- SubnetGroupNotFoundException
- SnapshotNotFoundException
- InvalidArnException
- TagNotFoundException
- ServiceLinkedRoleNotFoundException
- UserNotFoundException
- AclNotFoundException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateACL
Changes the list of users that belong to the Access Control List.
- Parameters:
updateAclRequest
-- Returns:
- A Java Future containing the result of the UpdateACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- UserNotFoundException
- DuplicateUserNameException
- DefaultUserRequiredException
- InvalidAclStateException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateACL
default CompletableFuture<UpdateAclResponse> updateACL(Consumer<UpdateAclRequest.Builder> updateAclRequest) Changes the list of users that belong to the Access Control List.
This is a convenience which creates an instance of the
UpdateAclRequest.Builder
avoiding the need to create one manually viaUpdateAclRequest.builder()
- Parameters:
updateAclRequest
- AConsumer
that will call methods onUpdateAclRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateACL operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AclNotFoundException
- UserNotFoundException
- DuplicateUserNameException
- DefaultUserRequiredException
- InvalidAclStateException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCluster
default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest) Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
- Parameters:
updateClusterRequest
-- Returns:
- A Java Future containing the result of the UpdateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- InvalidNodeStateException
- ParameterGroupNotFoundException
- InvalidVpcNetworkStateException
- ServiceLinkedRoleNotFoundException
- InvalidKmsKeyException
- NodeQuotaForClusterExceededException
- ClusterQuotaForCustomerExceededException
- ShardsPerClusterQuotaExceededException
- NodeQuotaForCustomerExceededException
- NoOperationException
- InvalidAclStateException
- AclNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCluster
default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest) Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
This is a convenience which creates an instance of the
UpdateClusterRequest.Builder
avoiding the need to create one manually viaUpdateClusterRequest.builder()
- Parameters:
updateClusterRequest
- AConsumer
that will call methods onUpdateClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ClusterNotFoundException
- InvalidClusterStateException
- InvalidNodeStateException
- ParameterGroupNotFoundException
- InvalidVpcNetworkStateException
- ServiceLinkedRoleNotFoundException
- InvalidKmsKeyException
- NodeQuotaForClusterExceededException
- ClusterQuotaForCustomerExceededException
- ShardsPerClusterQuotaExceededException
- NodeQuotaForCustomerExceededException
- NoOperationException
- InvalidAclStateException
- AclNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateParameterGroup
default CompletableFuture<UpdateParameterGroupResponse> updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest) Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
- Parameters:
updateParameterGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- InvalidParameterGroupStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateParameterGroup
default CompletableFuture<UpdateParameterGroupResponse> updateParameterGroup(Consumer<UpdateParameterGroupRequest.Builder> updateParameterGroupRequest) Updates the parameters of a 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
UpdateParameterGroupRequest.Builder
avoiding the need to create one manually viaUpdateParameterGroupRequest.builder()
- Parameters:
updateParameterGroupRequest
- AConsumer
that will call methods onUpdateParameterGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ParameterGroupNotFoundException
- InvalidParameterGroupStateException
- ServiceLinkedRoleNotFoundException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSubnetGroup
default CompletableFuture<UpdateSubnetGroupResponse> updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest) Updates a subnet group. For more information, see Updating a subnet group
- Parameters:
updateSubnetGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- SubnetQuotaExceededException
- SubnetInUseException
- InvalidSubnetException
- ServiceLinkedRoleNotFoundException
- SubnetNotAllowedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSubnetGroup
default CompletableFuture<UpdateSubnetGroupResponse> updateSubnetGroup(Consumer<UpdateSubnetGroupRequest.Builder> updateSubnetGroupRequest) Updates a subnet group. For more information, see Updating a subnet group
This is a convenience which creates an instance of the
UpdateSubnetGroupRequest.Builder
avoiding the need to create one manually viaUpdateSubnetGroupRequest.builder()
- Parameters:
updateSubnetGroupRequest
- AConsumer
that will call methods onUpdateSubnetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSubnetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SubnetGroupNotFoundException
- SubnetQuotaExceededException
- SubnetInUseException
- InvalidSubnetException
- ServiceLinkedRoleNotFoundException
- SubnetNotAllowedException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
Changes user password(s) and/or access string.
- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidUserStateException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Changes user password(s) and/or access string.
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UserNotFoundException
- InvalidUserStateException
- InvalidParameterValueException
- InvalidParameterCombinationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- MemoryDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMemoryDbAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMemoryDbAsyncClient
.
-