com.amazonaws.services.docdbelastic

Class AbstractAmazonDocDBElastic

java.lang.Object

com.amazonaws.services.docdbelastic.AbstractAmazonDocDBElastic

All Implemented Interfaces:

AmazonDocDBElastic

Direct Known Subclasses:

AbstractAmazonDocDBElasticAsync

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

Abstract implementation of AmazonDocDBElastic. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

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

Method Detail

copyClusterSnapshot

public CopyClusterSnapshotResult copyClusterSnapshot(CopyClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElastic

Copies a snapshot of an elastic cluster.

Specified by:

copyClusterSnapshot in interface AmazonDocDBElastic

Returns:

Result of the CopyClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

createCluster

public CreateClusterResult createCluster(CreateClusterRequest request)

Description copied from interface: AmazonDocDBElastic

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

Specified by:

createCluster in interface AmazonDocDBElastic

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

AWS API Documentation

createClusterSnapshot

public CreateClusterSnapshotResult createClusterSnapshot(CreateClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElastic

Creates a snapshot of an elastic cluster.

Specified by:

createClusterSnapshot in interface AmazonDocDBElastic

Returns:

Result of the CreateClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

deleteCluster

public DeleteClusterResult deleteCluster(DeleteClusterRequest request)

Description copied from interface: AmazonDocDBElastic

Delete an elastic cluster.

Specified by:

deleteCluster in interface AmazonDocDBElastic

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

AWS API Documentation

deleteClusterSnapshot

public DeleteClusterSnapshotResult deleteClusterSnapshot(DeleteClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElastic

Delete an elastic cluster snapshot.

Specified by:

deleteClusterSnapshot in interface AmazonDocDBElastic

Returns:

Result of the DeleteClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

getCluster

public GetClusterResult getCluster(GetClusterRequest request)

Description copied from interface: AmazonDocDBElastic

Returns information about a specific elastic cluster.

Specified by:

getCluster in interface AmazonDocDBElastic

Returns:

Result of the GetCluster operation returned by the service.

See Also:

AWS API Documentation

getClusterSnapshot

public GetClusterSnapshotResult getClusterSnapshot(GetClusterSnapshotRequest request)

Description copied from interface: AmazonDocDBElastic

Returns information about a specific elastic cluster snapshot

Specified by:

getClusterSnapshot in interface AmazonDocDBElastic

Returns:

Result of the GetClusterSnapshot operation returned by the service.

See Also:

AWS API Documentation

listClusterSnapshots

public ListClusterSnapshotsResult listClusterSnapshots(ListClusterSnapshotsRequest request)

Description copied from interface: AmazonDocDBElastic

Returns information about snapshots for a specified elastic cluster.

Specified by:

listClusterSnapshots in interface AmazonDocDBElastic

Returns:

Result of the ListClusterSnapshots operation returned by the service.

See Also:

AWS API Documentation

listClusters

public ListClustersResult listClusters(ListClustersRequest request)

Description copied from interface: AmazonDocDBElastic

Returns information about provisioned Amazon DocumentDB elastic clusters.

Specified by:

listClusters in interface AmazonDocDBElastic

Returns:

Result of the ListClusters operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AmazonDocDBElastic

Lists all tags on a elastic cluster resource

Specified by:

listTagsForResource in interface AmazonDocDBElastic

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

restoreClusterFromSnapshot

public RestoreClusterFromSnapshotResult restoreClusterFromSnapshot(RestoreClusterFromSnapshotRequest request)

Description copied from interface: AmazonDocDBElastic

Restores an elastic cluster from a snapshot.

Specified by:

restoreClusterFromSnapshot in interface AmazonDocDBElastic

Returns:

Result of the RestoreClusterFromSnapshot operation returned by the service.

See Also:

AWS API Documentation

startCluster

public StartClusterResult startCluster(StartClusterRequest request)

Description copied from interface: AmazonDocDBElastic

Restarts the stopped elastic cluster that is specified by clusterARN.

Specified by:

startCluster in interface AmazonDocDBElastic

Returns:

Result of the StartCluster operation returned by the service.

See Also:

AWS API Documentation

stopCluster

public StopClusterResult stopCluster(StopClusterRequest request)

Description copied from interface: AmazonDocDBElastic

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

Returns:

Result of the StopCluster operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AmazonDocDBElastic

Adds metadata tags to an elastic cluster resource

Specified by:

tagResource in interface AmazonDocDBElastic

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AmazonDocDBElastic

Removes metadata tags from an elastic cluster resource

Specified by:

untagResource in interface AmazonDocDBElastic

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateCluster

public UpdateClusterResult updateCluster(UpdateClusterRequest request)

Description copied from interface: AmazonDocDBElastic

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

Returns:

Result of the UpdateCluster operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonDocDBElastic

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.

Specified by:

shutdown in interface AmazonDocDBElastic

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonDocDBElastic

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.

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.