com.amazonaws.services.docdbelastic

Interface AmazonDocDBElasticAsync

All Superinterfaces:

AmazonDocDBElastic

All Known Implementing Classes:

AbstractAmazonDocDBElasticAsync, AmazonDocDBElasticAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDocDBElasticAsync
extends AmazonDocDBElastic

Interface for accessing DocDB Elastic asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDocDBElasticAsync instead.

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 inherited from interface com.amazonaws.services.docdbelastic.AmazonDocDBElastic

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CopyClusterSnapshotResult>	copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest) Copies a snapshot of an elastic cluster.
Future<CopyClusterSnapshotResult>	copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest, AsyncHandler<CopyClusterSnapshotRequest,CopyClusterSnapshotResult> asyncHandler) Copies a snapshot of an elastic cluster.
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest createClusterRequest) Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
Future<CreateClusterResult>	createClusterAsync(CreateClusterRequest createClusterRequest, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler) Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
Future<CreateClusterSnapshotResult>	createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest) Creates a snapshot of an elastic cluster.
Future<CreateClusterSnapshotResult>	createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest, AsyncHandler<CreateClusterSnapshotRequest,CreateClusterSnapshotResult> asyncHandler) Creates a snapshot of an elastic cluster.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest deleteClusterRequest) Delete an elastic cluster.
Future<DeleteClusterResult>	deleteClusterAsync(DeleteClusterRequest deleteClusterRequest, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler) Delete an elastic cluster.
Future<DeleteClusterSnapshotResult>	deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) Delete an elastic cluster snapshot.
Future<DeleteClusterSnapshotResult>	deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest, AsyncHandler<DeleteClusterSnapshotRequest,DeleteClusterSnapshotResult> asyncHandler) Delete an elastic cluster snapshot.
Future<GetClusterResult>	getClusterAsync(GetClusterRequest getClusterRequest) Returns information about a specific elastic cluster.
Future<GetClusterResult>	getClusterAsync(GetClusterRequest getClusterRequest, AsyncHandler<GetClusterRequest,GetClusterResult> asyncHandler) Returns information about a specific elastic cluster.
Future<GetClusterSnapshotResult>	getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest) Returns information about a specific elastic cluster snapshot
Future<GetClusterSnapshotResult>	getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest, AsyncHandler<GetClusterSnapshotRequest,GetClusterSnapshotResult> asyncHandler) Returns information about a specific elastic cluster snapshot
Future<ListClustersResult>	listClustersAsync(ListClustersRequest listClustersRequest) Returns information about provisioned Amazon DocumentDB elastic clusters.
Future<ListClustersResult>	listClustersAsync(ListClustersRequest listClustersRequest, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler) Returns information about provisioned Amazon DocumentDB elastic clusters.
Future<ListClusterSnapshotsResult>	listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest) Returns information about snapshots for a specified elastic cluster.
Future<ListClusterSnapshotsResult>	listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest, AsyncHandler<ListClusterSnapshotsRequest,ListClusterSnapshotsResult> asyncHandler) Returns information about snapshots for a specified elastic cluster.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a elastic cluster resource
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists all tags on a elastic cluster resource
Future<RestoreClusterFromSnapshotResult>	restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest) Restores an elastic cluster from a snapshot.
Future<RestoreClusterFromSnapshotResult>	restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest, AsyncHandler<RestoreClusterFromSnapshotRequest,RestoreClusterFromSnapshotResult> asyncHandler) Restores an elastic cluster from a snapshot.
Future<StartClusterResult>	startClusterAsync(StartClusterRequest startClusterRequest) Restarts the stopped elastic cluster that is specified by clusterARN.
Future<StartClusterResult>	startClusterAsync(StartClusterRequest startClusterRequest, AsyncHandler<StartClusterRequest,StartClusterResult> asyncHandler) Restarts the stopped elastic cluster that is specified by clusterARN.
Future<StopClusterResult>	stopClusterAsync(StopClusterRequest stopClusterRequest) Stops the running elastic cluster that is specified by clusterArn.
Future<StopClusterResult>	stopClusterAsync(StopClusterRequest stopClusterRequest, AsyncHandler<StopClusterRequest,StopClusterResult> asyncHandler) Stops the running elastic cluster that is specified by clusterArn.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest) Adds metadata tags to an elastic cluster resource
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds metadata tags to an elastic cluster resource
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest) Removes metadata tags from an elastic cluster resource
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes metadata tags from an elastic cluster resource
Future<UpdateClusterResult>	updateClusterAsync(UpdateClusterRequest updateClusterRequest) Modifies an elastic cluster.
Future<UpdateClusterResult>	updateClusterAsync(UpdateClusterRequest updateClusterRequest, AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler) Modifies an elastic cluster.

Methods inherited from interface com.amazonaws.services.docdbelastic.AmazonDocDBElastic

copyClusterSnapshot, createCluster, createClusterSnapshot, deleteCluster, deleteClusterSnapshot, getCachedResponseMetadata, getCluster, getClusterSnapshot, listClusters, listClusterSnapshots, listTagsForResource, restoreClusterFromSnapshot, shutdown, startCluster, stopCluster, tagResource, untagResource, updateCluster

Method Detail

copyClusterSnapshotAsync

Future<CopyClusterSnapshotResult> copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest)

Copies a snapshot of an elastic cluster.

Parameters:

copyClusterSnapshotRequest -

Returns:

A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

copyClusterSnapshotAsync

Future<CopyClusterSnapshotResult> copyClusterSnapshotAsync(CopyClusterSnapshotRequest copyClusterSnapshotRequest,
                                                           AsyncHandler<CopyClusterSnapshotRequest,CopyClusterSnapshotResult> asyncHandler)

Copies a snapshot of an elastic cluster.

Parameters:

copyClusterSnapshotRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CopyClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

createClusterAsync

Future<CreateClusterResult> createClusterAsync(CreateClusterRequest createClusterRequest)

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

Parameters:

createClusterRequest -

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.

See Also:

AWS API Documentation

createClusterAsync

Future<CreateClusterResult> createClusterAsync(CreateClusterRequest createClusterRequest,
                                               AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)

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

Parameters:

createClusterRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateCluster operation returned by the service.

See Also:

AWS API Documentation

createClusterSnapshotAsync

Future<CreateClusterSnapshotResult> createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest)

Creates a snapshot of an elastic cluster.

Parameters:

createClusterSnapshotRequest -

Returns:

A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

createClusterSnapshotAsync

Future<CreateClusterSnapshotResult> createClusterSnapshotAsync(CreateClusterSnapshotRequest createClusterSnapshotRequest,
                                                               AsyncHandler<CreateClusterSnapshotRequest,CreateClusterSnapshotResult> asyncHandler)

Creates a snapshot of an elastic cluster.

Parameters:

createClusterSnapshotRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest deleteClusterRequest)

Delete an elastic cluster.

Parameters:

deleteClusterRequest -

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterAsync

Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest deleteClusterRequest,
                                               AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)

Delete an elastic cluster.

Parameters:

deleteClusterRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterSnapshotAsync

Future<DeleteClusterSnapshotResult> deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)

Delete an elastic cluster snapshot.

Parameters:

deleteClusterSnapshotRequest -

Returns:

A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

deleteClusterSnapshotAsync

Future<DeleteClusterSnapshotResult> deleteClusterSnapshotAsync(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest,
                                                               AsyncHandler<DeleteClusterSnapshotRequest,DeleteClusterSnapshotResult> asyncHandler)

Delete an elastic cluster snapshot.

Parameters:

deleteClusterSnapshotRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

getClusterAsync

Future<GetClusterResult> getClusterAsync(GetClusterRequest getClusterRequest)

Returns information about a specific elastic cluster.

Parameters:

getClusterRequest -

Returns:

A Java Future containing the result of the GetCluster operation returned by the service.

See Also:

AWS API Documentation

getClusterAsync

Future<GetClusterResult> getClusterAsync(GetClusterRequest getClusterRequest,
                                         AsyncHandler<GetClusterRequest,GetClusterResult> asyncHandler)

Returns information about a specific elastic cluster.

Parameters:

getClusterRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetCluster operation returned by the service.

See Also:

AWS API Documentation

getClusterSnapshotAsync

Future<GetClusterSnapshotResult> getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest)

Returns information about a specific elastic cluster snapshot

Parameters:

getClusterSnapshotRequest -

Returns:

A Java Future containing the result of the GetClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

getClusterSnapshotAsync

Future<GetClusterSnapshotResult> getClusterSnapshotAsync(GetClusterSnapshotRequest getClusterSnapshotRequest,
                                                         AsyncHandler<GetClusterSnapshotRequest,GetClusterSnapshotResult> asyncHandler)

Returns information about a specific elastic cluster snapshot

Parameters:

getClusterSnapshotRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

listClusterSnapshotsAsync

Future<ListClusterSnapshotsResult> listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest)

Returns information about snapshots for a specified elastic cluster.

Parameters:

listClusterSnapshotsRequest -

Returns:

A Java Future containing the result of the ListClusterSnapshots operation returned by the service.

See Also:

AWS API Documentation

listClusterSnapshotsAsync

Future<ListClusterSnapshotsResult> listClusterSnapshotsAsync(ListClusterSnapshotsRequest listClusterSnapshotsRequest,
                                                             AsyncHandler<ListClusterSnapshotsRequest,ListClusterSnapshotsResult> asyncHandler)

Returns information about snapshots for a specified elastic cluster.

Parameters:

listClusterSnapshotsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListClusterSnapshots operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

Future<ListClustersResult> listClustersAsync(ListClustersRequest listClustersRequest)

Returns information about provisioned Amazon DocumentDB elastic clusters.

Parameters:

listClustersRequest -

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.

See Also:

AWS API Documentation

listClustersAsync

Future<ListClustersResult> listClustersAsync(ListClustersRequest listClustersRequest,
                                             AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)

Returns information about provisioned Amazon DocumentDB elastic clusters.

Parameters:

listClustersRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListClusters operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on a elastic cluster resource

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Lists all tags on a elastic cluster resource

Parameters:

listTagsForResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

restoreClusterFromSnapshotAsync

Future<RestoreClusterFromSnapshotResult> restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)

Restores an elastic cluster from a snapshot.

Parameters:

restoreClusterFromSnapshotRequest -

Returns:

A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.

See Also:

AWS API Documentation

restoreClusterFromSnapshotAsync

Future<RestoreClusterFromSnapshotResult> restoreClusterFromSnapshotAsync(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest,
                                                                         AsyncHandler<RestoreClusterFromSnapshotRequest,RestoreClusterFromSnapshotResult> asyncHandler)

Restores an elastic cluster from a snapshot.

Parameters:

restoreClusterFromSnapshotRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RestoreClusterFromSnapshot operation returned by the service.

See Also:

AWS API Documentation

startClusterAsync

Future<StartClusterResult> startClusterAsync(StartClusterRequest startClusterRequest)

Restarts the stopped elastic cluster that is specified by clusterARN.

Parameters:

startClusterRequest -

Returns:

A Java Future containing the result of the StartCluster operation returned by the service.

See Also:

AWS API Documentation

startClusterAsync

Future<StartClusterResult> startClusterAsync(StartClusterRequest startClusterRequest,
                                             AsyncHandler<StartClusterRequest,StartClusterResult> asyncHandler)

Restarts the stopped elastic cluster that is specified by clusterARN.

Parameters:

startClusterRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartCluster operation returned by the service.

See Also:

AWS API Documentation

stopClusterAsync

Future<StopClusterResult> stopClusterAsync(StopClusterRequest stopClusterRequest)

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

Parameters:

stopClusterRequest -

Returns:

A Java Future containing the result of the StopCluster operation returned by the service.

See Also:

AWS API Documentation

stopClusterAsync

Future<StopClusterResult> stopClusterAsync(StopClusterRequest stopClusterRequest,
                                           AsyncHandler<StopClusterRequest,StopClusterResult> asyncHandler)

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

Parameters:

stopClusterRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StopCluster operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)

Adds metadata tags to an elastic cluster resource

Parameters:

tagResourceRequest -

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Adds metadata tags to an elastic cluster resource

Parameters:

tagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)

Removes metadata tags from an elastic cluster resource

Parameters:

untagResourceRequest -

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Removes metadata tags from an elastic cluster resource

Parameters:

untagResourceRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateClusterAsync

Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest updateClusterRequest)

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:

A Java Future containing the result of the UpdateCluster operation returned by the service.

See Also:

AWS API Documentation

updateClusterAsync

Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest updateClusterRequest,
                                               AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateCluster operation returned by the service.

See Also:

AWS API Documentation