AWS.DocDBElastic — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

Sending a Request Using DocDBElastic

var docdbelastic = new AWS.DocDBElastic();
docdbelastic.copyClusterSnapshot(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DocDBElastic object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var docdbelastic = new AWS.DocDBElastic({apiVersion: '2022-11-28'});

You can also set the API version globally in AWS.config.apiVersions using the docdbelastic service identifier:

AWS.config.apiVersions = {
  docdbelastic: '2022-11-28',
  // other service API versions
};

var docdbelastic = new AWS.DocDBElastic();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DocDBElastic(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

copyClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Copies a snapshot of an elastic cluster.

createCluster(params = {}, callback) ⇒ AWS.Request

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

createClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of an elastic cluster.

deleteCluster(params = {}, callback) ⇒ AWS.Request

Delete an elastic cluster.

deleteClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Delete an elastic cluster snapshot.

getCluster(params = {}, callback) ⇒ AWS.Request

Returns information about a specific elastic cluster.

getClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Returns information about a specific elastic cluster snapshot

listClusters(params = {}, callback) ⇒ AWS.Request

Returns information about provisioned Amazon DocumentDB elastic clusters.

listClusterSnapshots(params = {}, callback) ⇒ AWS.Request

Returns information about snapshots for a specified elastic cluster.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on a elastic cluster resource

restoreClusterFromSnapshot(params = {}, callback) ⇒ AWS.Request

Restores an elastic cluster from a snapshot.

startCluster(params = {}, callback) ⇒ AWS.Request

Restarts the stopped elastic cluster that is specified by clusterARN.

stopCluster(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to an elastic cluster resource

untagResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from an elastic cluster resource

updateCluster(params = {}, callback) ⇒ AWS.Request

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