com.amazonaws.services.docdbelastic

Class AmazonDocDBElasticClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.docdbelastic.AmazonDocDBElasticClient

All Implemented Interfaces:

AmazonDocDBElastic

Direct Known Subclasses:

AmazonDocDBElasticAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDocDBElasticClient
extends AmazonWebServiceClient
implements AmazonDocDBElastic

Client for accessing DocDB Elastic. All service calls made using this client are blocking, and will not return until the service call completes.

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 class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonDocDBElasticClientBuilder	builder()
CopyClusterSnapshotResult	copyClusterSnapshot(CopyClusterSnapshotRequest request) Copies a snapshot of an elastic cluster.
CreateClusterResult	createCluster(CreateClusterRequest request) Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
CreateClusterSnapshotResult	createClusterSnapshot(CreateClusterSnapshotRequest request) Creates a snapshot of an elastic cluster.
DeleteClusterResult	deleteCluster(DeleteClusterRequest request) Delete an elastic cluster.
DeleteClusterSnapshotResult	deleteClusterSnapshot(DeleteClusterSnapshotRequest request) Delete an elastic cluster snapshot.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetClusterResult	getCluster(GetClusterRequest request) Returns information about a specific elastic cluster.
GetClusterSnapshotResult	getClusterSnapshot(GetClusterSnapshotRequest request) Returns information about a specific elastic cluster snapshot
ListClustersResult	listClusters(ListClustersRequest request) Returns information about provisioned Amazon DocumentDB elastic clusters.
ListClusterSnapshotsResult	listClusterSnapshots(ListClusterSnapshotsRequest request) Returns information about snapshots for a specified elastic cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags on a elastic cluster resource
RestoreClusterFromSnapshotResult	restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest request) Restores an elastic cluster from a snapshot.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartClusterResult	startCluster(StartClusterRequest request) Restarts the stopped elastic cluster that is specified by clusterARN.
StopClusterResult	stopCluster(StopClusterRequest request) Stops the running elastic cluster that is specified by clusterArn.
TagResourceResult	tagResource(TagResourceRequest request) Adds metadata tags to an elastic cluster resource
UntagResourceResult	untagResource(UntagResourceRequest request) Removes metadata tags from an elastic cluster resource
UpdateClusterResult	updateCluster(UpdateClusterRequest request) Modifies an elastic cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonDocDBElasticClientBuilder builder()

copyClusterSnapshot

public CopyClusterSnapshotResult copyClusterSnapshot(CopyClusterSnapshotRequest request)

Copies a snapshot of an elastic cluster.

Specified by:

copyClusterSnapshot in interface AmazonDocDBElastic

Parameters:

copyClusterSnapshotRequest -

Returns:

Result of the CopyClusterSnapshot operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ServiceQuotaExceededException - The service quota for the action was exceeded.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

createCluster

public CreateClusterResult createCluster(CreateClusterRequest request)

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

Specified by:

createCluster in interface AmazonDocDBElastic

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ServiceQuotaExceededException - The service quota for the action was exceeded.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

createClusterSnapshot

public CreateClusterSnapshotResult createClusterSnapshot(CreateClusterSnapshotRequest request)

Creates a snapshot of an elastic cluster.

Specified by:

createClusterSnapshot in interface AmazonDocDBElastic

Parameters:

createClusterSnapshotRequest -

Returns:

Result of the CreateClusterSnapshot operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ServiceQuotaExceededException - The service quota for the action was exceeded.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

deleteCluster

public DeleteClusterResult deleteCluster(DeleteClusterRequest request)

Delete an elastic cluster.

Specified by:

deleteCluster in interface AmazonDocDBElastic

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

deleteClusterSnapshot

public DeleteClusterSnapshotResult deleteClusterSnapshot(DeleteClusterSnapshotRequest request)

Delete an elastic cluster snapshot.

Specified by:

deleteClusterSnapshot in interface AmazonDocDBElastic

Parameters:

deleteClusterSnapshotRequest -

Returns:

Result of the DeleteClusterSnapshot operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

getCluster

public GetClusterResult getCluster(GetClusterRequest request)

Returns information about a specific elastic cluster.

Specified by:

getCluster in interface AmazonDocDBElastic

Parameters:

getClusterRequest -

Returns:

Result of the GetCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

getClusterSnapshot

public GetClusterSnapshotResult getClusterSnapshot(GetClusterSnapshotRequest request)

Returns information about a specific elastic cluster snapshot

Specified by:

getClusterSnapshot in interface AmazonDocDBElastic

Parameters:

getClusterSnapshotRequest -

Returns:

Result of the GetClusterSnapshot operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

listClusterSnapshots

public ListClusterSnapshotsResult listClusterSnapshots(ListClusterSnapshotsRequest request)

Returns information about snapshots for a specified elastic cluster.

Specified by:

listClusterSnapshots in interface AmazonDocDBElastic

Parameters:

listClusterSnapshotsRequest -

Returns:

Result of the ListClusterSnapshots operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

listClusters

public ListClustersResult listClusters(ListClustersRequest request)

Returns information about provisioned Amazon DocumentDB elastic clusters.

Specified by:

listClusters in interface AmazonDocDBElastic

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags on a elastic cluster resource

Specified by:

listTagsForResource in interface AmazonDocDBElastic

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

See Also:

AWS API Documentation

restoreClusterFromSnapshot

public RestoreClusterFromSnapshotResult restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest request)

Restores an elastic cluster from a snapshot.

Specified by:

restoreClusterFromSnapshot in interface AmazonDocDBElastic

Parameters:

restoreClusterFromSnapshotRequest -

Returns:

Result of the RestoreClusterFromSnapshot operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ServiceQuotaExceededException - The service quota for the action was exceeded.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

startCluster

public StartClusterResult startCluster(StartClusterRequest request)

Restarts the stopped elastic cluster that is specified by clusterARN.

Specified by:

startCluster in interface AmazonDocDBElastic

Parameters:

startClusterRequest -

Returns:

Result of the StartCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

stopCluster

public StopClusterResult stopCluster(StopClusterRequest request)

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

Specified by:

stopCluster in interface AmazonDocDBElastic

Parameters:

stopClusterRequest -

Returns:

Result of the StopCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds metadata tags to an elastic cluster resource

Specified by:

tagResource in interface AmazonDocDBElastic

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes metadata tags from an elastic cluster resource

Specified by:

untagResource in interface AmazonDocDBElastic

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

See Also:

AWS API Documentation

updateCluster

public UpdateClusterResult updateCluster(UpdateClusterRequest request)

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

Specified by:

updateCluster in interface AmazonDocDBElastic

Parameters:

updateClusterRequest -

Returns:

Result of the UpdateCluster operation returned by the service.

Throws:

ThrottlingException - ThrottlingException will be thrown when request was denied due to request throttling.

ValidationException - A structure defining a validation exception.

ConflictException - There was an access conflict.

InternalServerException - There was an internal server error.

ResourceNotFoundException - The specified resource could not be located.

AccessDeniedException - An exception that occurs when there are not sufficient permissions to perform an action.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonDocDBElastic

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonDocDBElastic

Overrides:

shutdown in class AmazonWebServiceClient