Package software.amazon.awssdk.services.docdbelastic

Interface DocDbElasticClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DocDbElasticClient
extends AwsClient

Service client for accessing DocDB Elastic. This can be created using the static builder() method.

Amazon DocumentDB elastic clusters

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

Amazon DocumentDB elastic-clusters were created to:

• provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.

• give customers higher connection limits, and to reduce downtime from patching.

• continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DocDbElasticClientBuilder	builder()	Create a builder that can be used to configure and create a DocDbElasticClient.
default CopyClusterSnapshotResponse	copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)	Copies a snapshot of an elastic cluster.
default CopyClusterSnapshotResponse	copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)	Copies a snapshot of an elastic cluster.
static DocDbElasticClient	create()	Create a DocDbElasticClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
default CreateClusterSnapshotResponse	createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)	Creates a snapshot of an elastic cluster.
default CreateClusterSnapshotResponse	createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)	Creates a snapshot of an elastic cluster.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Delete an elastic cluster.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Delete an elastic cluster.
default DeleteClusterSnapshotResponse	deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)	Delete an elastic cluster snapshot.
default DeleteClusterSnapshotResponse	deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)	Delete an elastic cluster snapshot.
default GetClusterResponse	getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)	Returns information about a specific elastic cluster.
default GetClusterResponse	getCluster(GetClusterRequest getClusterRequest)	Returns information about a specific elastic cluster.
default GetClusterSnapshotResponse	getClusterSnapshot(Consumer<GetClusterSnapshotRequest.Builder> getClusterSnapshotRequest)	Returns information about a specific elastic cluster snapshot
default GetClusterSnapshotResponse	getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)	Returns information about a specific elastic cluster snapshot
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Returns information about provisioned Amazon DocumentDB elastic clusters.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Returns information about provisioned Amazon DocumentDB elastic clusters.
default ListClusterSnapshotsResponse	listClusterSnapshots(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)	Returns information about snapshots for a specified elastic cluster.
default ListClusterSnapshotsResponse	listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)	Returns information about snapshots for a specified elastic cluster.
default ListClusterSnapshotsIterable	listClusterSnapshotsPaginator(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)	This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.
default ListClusterSnapshotsIterable	listClusterSnapshotsPaginator(ListClusterSnapshotsRequest listClusterSnapshotsRequest)	This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags on a elastic cluster resource
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags on a elastic cluster resource
default RestoreClusterFromSnapshotResponse	restoreClusterFromSnapshot(Consumer<RestoreClusterFromSnapshotRequest.Builder> restoreClusterFromSnapshotRequest)	Restores an elastic cluster from a snapshot.
default RestoreClusterFromSnapshotResponse	restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)	Restores an elastic cluster from a snapshot.
default DocDbElasticServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartClusterResponse	startCluster(Consumer<StartClusterRequest.Builder> startClusterRequest)	Restarts the stopped elastic cluster that is specified by clusterARN.
default StartClusterResponse	startCluster(StartClusterRequest startClusterRequest)	Restarts the stopped elastic cluster that is specified by clusterARN.
default StopClusterResponse	stopCluster(Consumer<StopClusterRequest.Builder> stopClusterRequest)	Stops the running elastic cluster that is specified by clusterArn.
default StopClusterResponse	stopCluster(StopClusterRequest stopClusterRequest)	Stops the running elastic cluster that is specified by clusterArn.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds metadata tags to an elastic cluster resource
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds metadata tags to an elastic cluster resource
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes metadata tags from an elastic cluster resource
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes metadata tags from an elastic cluster resource
default UpdateClusterResponse	updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)	Modifies an elastic cluster.
default UpdateClusterResponse	updateCluster(UpdateClusterRequest updateClusterRequest)	Modifies an elastic cluster.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

copyClusterSnapshot

default CopyClusterSnapshotResponse copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)
                                                 throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Copies a snapshot of an elastic cluster.

Parameters:

copyClusterSnapshotRequest -

Returns:

Result of the CopyClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

copyClusterSnapshot

default CopyClusterSnapshotResponse copyClusterSnapshot(Consumer<CopyClusterSnapshotRequest.Builder> copyClusterSnapshotRequest)
                                                 throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Copies a snapshot of an elastic cluster.

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

Parameters:

copyClusterSnapshotRequest - A Consumer that will call methods on CopyClusterSnapshotRequest.Builder to create a request.

Returns:

Result of the CopyClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

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

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createClusterSnapshot

default CreateClusterSnapshotResponse createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)
                                                     throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Creates a snapshot of an elastic cluster.

Parameters:

createClusterSnapshotRequest -

Returns:

Result of the CreateClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

createClusterSnapshot

default CreateClusterSnapshotResponse createClusterSnapshot(Consumer<CreateClusterSnapshotRequest.Builder> createClusterSnapshotRequest)
                                                     throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Creates a snapshot of an elastic cluster.

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

Parameters:

createClusterSnapshotRequest - A Consumer that will call methods on CreateClusterSnapshotRequest.Builder to create a request.

Returns:

Result of the CreateClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Delete an elastic cluster.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Delete an elastic cluster.

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

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteClusterSnapshot

default DeleteClusterSnapshotResponse deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)
                                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Delete an elastic cluster snapshot.

Parameters:

deleteClusterSnapshotRequest -

Returns:

Result of the DeleteClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

deleteClusterSnapshot

default DeleteClusterSnapshotResponse deleteClusterSnapshot(Consumer<DeleteClusterSnapshotRequest.Builder> deleteClusterSnapshotRequest)
                                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Delete an elastic cluster snapshot.

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

Parameters:

deleteClusterSnapshotRequest - A Consumer that will call methods on DeleteClusterSnapshotRequest.Builder to create a request.

Returns:

Result of the DeleteClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(GetClusterRequest getClusterRequest)
                               throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about a specific elastic cluster.

Parameters:

getClusterRequest -

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
                               throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about a specific elastic cluster.

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

Parameters:

getClusterRequest - A Consumer that will call methods on GetClusterRequest.Builder to create a request.

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getClusterSnapshot

default GetClusterSnapshotResponse getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)
                                               throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about a specific elastic cluster snapshot

Parameters:

getClusterSnapshotRequest -

Returns:

Result of the GetClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

getClusterSnapshot

default GetClusterSnapshotResponse getClusterSnapshot(Consumer<GetClusterSnapshotRequest.Builder> getClusterSnapshotRequest)
                                               throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about a specific elastic cluster snapshot

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

Parameters:

getClusterSnapshotRequest - A Consumer that will call methods on GetClusterSnapshotRequest.Builder to create a request.

Returns:

Result of the GetClusterSnapshot operation returned by the service.

See Also:

• AWS API Documentation

listClusterSnapshots

default ListClusterSnapshotsResponse listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)
                                                   throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about snapshots for a specified elastic cluster.

Parameters:

listClusterSnapshotsRequest -

Returns:

Result of the ListClusterSnapshots operation returned by the service.

See Also:

• AWS API Documentation

listClusterSnapshots

default ListClusterSnapshotsResponse listClusterSnapshots(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)
                                                   throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about snapshots for a specified elastic cluster.

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

Parameters:

listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsRequest.Builder to create a request.

Returns:

Result of the ListClusterSnapshots operation returned by the service.

See Also:

• AWS API Documentation

listClusterSnapshotsPaginator

default ListClusterSnapshotsIterable listClusterSnapshotsPaginator(ListClusterSnapshotsRequest listClusterSnapshotsRequest)
                                                            throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client
             .listClusterSnapshotsPaginator(request);
     for (software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.

Parameters:

listClusterSnapshotsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClusterSnapshotsPaginator

default ListClusterSnapshotsIterable listClusterSnapshotsPaginator(Consumer<ListClusterSnapshotsRequest.Builder> listClusterSnapshotsRequest)
                                                            throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

This is a variant of listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client
             .listClusterSnapshotsPaginator(request);
     for (software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClusterSnapshotsIterable responses = client.listClusterSnapshotsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listClusterSnapshots(software.amazon.awssdk.services.docdbelastic.model.ListClusterSnapshotsRequest) operation.

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

Parameters:

listClusterSnapshotsRequest - A Consumer that will call methods on ListClusterSnapshotsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about provisioned Amazon DocumentDB elastic clusters.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Returns information about provisioned Amazon DocumentDB elastic clusters.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client
             .listClustersPaginator(request);
     for (software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

This is a variant of listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client
             .listClustersPaginator(request);
     for (software.amazon.awssdk.services.docdbelastic.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.docdbelastic.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.docdbelastic.model.ListClustersRequest) operation.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Lists all tags on a elastic cluster resource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Lists all tags on a elastic cluster resource

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

restoreClusterFromSnapshot

default RestoreClusterFromSnapshotResponse restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)
                                                               throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Restores an elastic cluster from a snapshot.

Parameters:

restoreClusterFromSnapshotRequest -

Returns:

Result of the RestoreClusterFromSnapshot operation returned by the service.

See Also:

• AWS API Documentation

restoreClusterFromSnapshot

default RestoreClusterFromSnapshotResponse restoreClusterFromSnapshot(Consumer<RestoreClusterFromSnapshotRequest.Builder> restoreClusterFromSnapshotRequest)
                                                               throws ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Restores an elastic cluster from a snapshot.

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

Parameters:

restoreClusterFromSnapshotRequest - A Consumer that will call methods on RestoreClusterFromSnapshotRequest.Builder to create a request.

Returns:

Result of the RestoreClusterFromSnapshot operation returned by the service.

See Also:

• AWS API Documentation

startCluster

default StartClusterResponse startCluster(StartClusterRequest startClusterRequest)
                                   throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Restarts the stopped elastic cluster that is specified by clusterARN.

Parameters:

startClusterRequest -

Returns:

Result of the StartCluster operation returned by the service.

See Also:

• AWS API Documentation

startCluster

default StartClusterResponse startCluster(Consumer<StartClusterRequest.Builder> startClusterRequest)
                                   throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Restarts the stopped elastic cluster that is specified by clusterARN.

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

Parameters:

startClusterRequest - A Consumer that will call methods on StartClusterRequest.Builder to create a request.

Returns:

Result of the StartCluster operation returned by the service.

See Also:

• AWS API Documentation

stopCluster

default StopClusterResponse stopCluster(StopClusterRequest stopClusterRequest)
                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

Parameters:

stopClusterRequest -

Returns:

Result of the StopCluster operation returned by the service.

See Also:

• AWS API Documentation

stopCluster

default StopClusterResponse stopCluster(Consumer<StopClusterRequest.Builder> stopClusterRequest)
                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

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

Parameters:

stopClusterRequest - A Consumer that will call methods on StopClusterRequest.Builder to create a request.

Returns:

Result of the StopCluster operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Adds metadata tags to an elastic cluster resource

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Adds metadata tags to an elastic cluster resource

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Removes metadata tags from an elastic cluster resource

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ThrottlingException,
ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Removes metadata tags from an elastic cluster resource

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(UpdateClusterRequest updateClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

updateCluster

default UpdateClusterResponse updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
DocDbElasticException

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

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

Parameters:

updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

• AWS API Documentation

create

static DocDbElasticClient create()

Create a DocDbElasticClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DocDbElasticClientBuilder builder()

Create a builder that can be used to configure and create a DocDbElasticClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DocDbElasticServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration