com.amazonaws.services.docdbelastic

Interface AmazonDocDBElastic

All Known Subinterfaces:

AmazonDocDBElasticAsync

All Known Implementing Classes:

AbstractAmazonDocDBElastic, AbstractAmazonDocDBElasticAsync, AmazonDocDBElasticAsyncClient, AmazonDocDBElasticClient

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

Interface for accessing DocDB Elastic.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDocDBElastic 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CopyClusterSnapshotResult	copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest) Copies a snapshot of an elastic cluster.
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
CreateClusterSnapshotResult	createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest) Creates a snapshot of an elastic cluster.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Delete an elastic cluster.
DeleteClusterSnapshotResult	deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest) 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 getClusterRequest) Returns information about a specific elastic cluster.
GetClusterSnapshotResult	getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest) Returns information about a specific elastic cluster snapshot
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns information about provisioned Amazon DocumentDB elastic clusters.
ListClusterSnapshotsResult	listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest) Returns information about snapshots for a specified elastic cluster.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on a elastic cluster resource
RestoreClusterFromSnapshotResult	restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest) 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 startClusterRequest) Restarts the stopped elastic cluster that is specified by clusterARN.
StopClusterResult	stopCluster(StopClusterRequest stopClusterRequest) Stops the running elastic cluster that is specified by clusterArn.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to an elastic cluster resource
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from an elastic cluster resource
UpdateClusterResult	updateCluster(UpdateClusterRequest updateClusterRequest) Modifies an elastic cluster.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

copyClusterSnapshot

CopyClusterSnapshotResult copyClusterSnapshot(CopyClusterSnapshotRequest copyClusterSnapshotRequest)

Copies a snapshot of an elastic cluster.

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

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

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

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

CreateClusterSnapshotResult createClusterSnapshot(CreateClusterSnapshotRequest createClusterSnapshotRequest)

Creates a snapshot of an elastic cluster.

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

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

Delete an elastic cluster.

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

DeleteClusterSnapshotResult deleteClusterSnapshot(DeleteClusterSnapshotRequest deleteClusterSnapshotRequest)

Delete an elastic cluster snapshot.

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

GetClusterResult getCluster(GetClusterRequest getClusterRequest)

Returns information about a specific elastic cluster.

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

GetClusterSnapshotResult getClusterSnapshot(GetClusterSnapshotRequest getClusterSnapshotRequest)

Returns information about a specific elastic cluster snapshot

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

ListClusterSnapshotsResult listClusterSnapshots(ListClusterSnapshotsRequest listClusterSnapshotsRequest)

Returns information about snapshots for a specified elastic cluster.

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

ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Returns information about provisioned Amazon DocumentDB elastic clusters.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on a elastic cluster resource

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

RestoreClusterFromSnapshotResult restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest restoreClusterFromSnapshotRequest)

Restores an elastic cluster from a snapshot.

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

StartClusterResult startCluster(StartClusterRequest startClusterRequest)

Restarts the stopped elastic cluster that is specified by clusterARN.

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

StopClusterResult stopCluster(StopClusterRequest stopClusterRequest)

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.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds metadata tags to an elastic cluster resource

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes metadata tags from an elastic cluster resource

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

UpdateClusterResult updateCluster(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:

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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