Class: AWS.DocDBElastic

var params = {
  clusterArn: 'STRING_VALUE', /* required */
  snapshotName: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
docdbelastic.createClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterArn — (String)

    The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.

  • snapshotName — (String)

    The name of the Elastic DocumentDB snapshot.

  • tags — (map<String>)

    The tags to be assigned to the new Elastic DocumentDB snapshot.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • snapshot — (map)

      Returns information about the new Elastic DocumentDB snapshot.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterCreationTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • snapshotArn — required — (String)

        The arn of the Elastic DocumentDB snapshot

      • snapshotCreationTime — required — (String)

        The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the Elastic DocumentDB snapshot.

      • status — required — (String)

        The status of the Elastic DocumentDB snapshot.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        A list of the IDs of subnets associated with the DB cluster snapshot.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of the IDs of the VPC security groups associated with the cluster snapshot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterArn: 'STRING_VALUE' /* required */
};
docdbelastic.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterArn — (String)

    The arn of the Elastic DocumentDB cluster that is to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      Returns information about the newly deleted Elastic DocumentDB cluster.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • authType — required — (String)

        The authentication type for the Elastic DocumentDB cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the Elastic DocumentDB cluster.

      • clusterName — required — (String)

        The name of the Elastic DocumentDB cluster.

      • createTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • preferredMaintenanceWindow — required — (String)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity — required — (Integer)

        The capacity of each shard in the Elastic DocumentDB cluster.

      • shardCount — required — (Integer)

        The number of shards in the Elastic DocumentDB cluster.

      • status — required — (String)

        The status of the Elastic DocumentDB cluster.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with this cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  snapshotArn: 'STRING_VALUE' /* required */
};
docdbelastic.deleteClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • snapshotArn — (String)

    The arn of the Elastic DocumentDB snapshot that is to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • snapshot — (map)

      Returns information about the newly deleted Elastic DocumentDB snapshot.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterCreationTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • snapshotArn — required — (String)

        The arn of the Elastic DocumentDB snapshot

      • snapshotCreationTime — required — (String)

        The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the Elastic DocumentDB snapshot.

      • status — required — (String)

        The status of the Elastic DocumentDB snapshot.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        A list of the IDs of subnets associated with the DB cluster snapshot.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of the IDs of the VPC security groups associated with the cluster snapshot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterArn: 'STRING_VALUE' /* required */
};
docdbelastic.getCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterArn — (String)

    The arn of the Elastic DocumentDB cluster.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      Returns information about a specific Elastic DocumentDB cluster.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • authType — required — (String)

        The authentication type for the Elastic DocumentDB cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the Elastic DocumentDB cluster.

      • clusterName — required — (String)

        The name of the Elastic DocumentDB cluster.

      • createTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • preferredMaintenanceWindow — required — (String)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity — required — (Integer)

        The capacity of each shard in the Elastic DocumentDB cluster.

      • shardCount — required — (Integer)

        The number of shards in the Elastic DocumentDB cluster.

      • status — required — (String)

        The status of the Elastic DocumentDB cluster.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with this cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  snapshotArn: 'STRING_VALUE' /* required */
};
docdbelastic.getClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • snapshotArn — (String)

    The arn of the Elastic DocumentDB snapshot.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • snapshot — (map)

      Returns information about a specific Elastic DocumentDB snapshot.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterCreationTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • snapshotArn — required — (String)

        The arn of the Elastic DocumentDB snapshot

      • snapshotCreationTime — required — (String)

        The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the Elastic DocumentDB snapshot.

      • status — required — (String)

        The status of the Elastic DocumentDB snapshot.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        A list of the IDs of subnets associated with the DB cluster snapshot.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of the IDs of the VPC security groups associated with the cluster snapshot.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
docdbelastic.listClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of entries to recieve in the response.

  • nextToken — (String)

    The nextToken which is used the get the next page of data.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • clusters — (Array<map>)

      A list of Elastic DocumentDB cluster.

      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterName — required — (String)

        The name of the Elastic DocumentDB cluster.

      • status — required — (String)

        The status of the Elastic DocumentDB cluster.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
    • nextToken — (String)

      The response will provide a nextToken if there is more data beyond the maxResults.

      If there is no more data in the responce, the nextToken will not be returned.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
docdbelastic.listClusterSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterArn — (String)

    The arn of the Elastic DocumentDB cluster.

  • maxResults — (Integer)

    The maximum number of entries to recieve in the response.

  • nextToken — (String)

    The nextToken which is used the get the next page of data.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The response will provide a nextToken if there is more data beyond the maxResults.

      If there is no more data in the responce, the nextToken will not be returned.

    • snapshots — (Array<map>)

      A list of Elastic DocumentDB snapshots for a specified cluster.

      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • snapshotArn — required — (String)

        The arn of the Elastic DocumentDB snapshot

      • snapshotCreationTime — required — (String)

        The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the Elastic DocumentDB snapshot.

      • status — required — (String)

        The status of the Elastic DocumentDB snapshot.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
docdbelastic.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The arn of the Elastic DocumentDB resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The list of tags for the specified Elastic DocumentDB resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterName: 'STRING_VALUE', /* required */
  snapshotArn: 'STRING_VALUE', /* required */
  kmsKeyId: 'STRING_VALUE',
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  vpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdbelastic.restoreClusterFromSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • clusterName — (String)

    The name of the Elastic DocumentDB cluster.

  • kmsKeyId — (String)

    The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

    If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

  • snapshotArn — (String)

    The arn of the Elastic DocumentDB snapshot.

  • subnetIds — (Array<String>)

    The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

  • tags — (map<String>)

    A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

  • vpcSecurityGroupIds — (Array<String>)

    A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      Returns information about a the restored Elastic DocumentDB cluster.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • authType — required — (String)

        The authentication type for the Elastic DocumentDB cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the Elastic DocumentDB cluster.

      • clusterName — required — (String)

        The name of the Elastic DocumentDB cluster.

      • createTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • preferredMaintenanceWindow — required — (String)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity — required — (Integer)

        The capacity of each shard in the Elastic DocumentDB cluster.

      • shardCount — required — (Integer)

        The number of shards in the Elastic DocumentDB cluster.

      • status — required — (String)

        The status of the Elastic DocumentDB cluster.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with this cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
docdbelastic.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The arn of the Elastic DocumentDB resource.

  • tags — (map<String>)

    The tags to be assigned to the Elastic DocumentDB resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
docdbelastic.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The arn of the Elastic DocumentDB resource.

  • tagKeys — (Array<String>)

    The tag keys to be removed from the Elastic DocumentDB resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clusterArn: 'STRING_VALUE', /* required */
  adminUserPassword: 'STRING_VALUE',
  authType: PLAIN_TEXT | SECRET_ARN,
  clientToken: 'STRING_VALUE',
  preferredMaintenanceWindow: 'STRING_VALUE',
  shardCapacity: 'NUMBER_VALUE',
  shardCount: 'NUMBER_VALUE',
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  vpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdbelastic.updateCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • adminUserPassword — (String)

    The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

    Constraints: Must contain from 8 to 100 characters.

  • authType — (String)

    The authentication type for the Elastic DocumentDB cluster.

    Possible values include:
    • "PLAIN_TEXT"
    • "SECRET_ARN"
  • clientToken — (String)

    The client token for the Elastic DocumentDB cluster.

    If a token is not provided, the SDK will use a version 4 UUID.
  • clusterArn — (String)

    The arn of the Elastic DocumentDB cluster.

  • preferredMaintenanceWindow — (String)

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

  • shardCapacity — (Integer)

    The capacity of each shard in the Elastic DocumentDB cluster.

  • shardCount — (Integer)

    The number of shards to create in the Elastic DocumentDB cluster.

  • subnetIds — (Array<String>)

    The number of shards to create in the Elastic DocumentDB cluster.

  • vpcSecurityGroupIds — (Array<String>)

    A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • cluster — (map)

      Returns information about the updated Elastic DocumentDB cluster.

      • adminUserName — required — (String)

        The name of the Elastic DocumentDB cluster administrator.

      • authType — required — (String)

        The authentication type for the Elastic DocumentDB cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • clusterArn — required — (String)

        The arn of the Elastic DocumentDB cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the Elastic DocumentDB cluster.

      • clusterName — required — (String)

        The name of the Elastic DocumentDB cluster.

      • createTime — required — (String)

        The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • preferredMaintenanceWindow — required — (String)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity — required — (Integer)

        The capacity of each shard in the Elastic DocumentDB cluster.

      • shardCount — required — (Integer)

        The number of shards in the Elastic DocumentDB cluster.

      • status — required — (String)

        The status of the Elastic DocumentDB cluster.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "UPDATING"
        • "VPC_ENDPOINT_LIMIT_EXCEEDED"
        • "IP_ADDRESS_LIMIT_EXCEEDED"
        • "INVALID_SECURITY_GROUP_ID"
        • "INVALID_SUBNET_ID"
        • "INACCESSIBLE_ENCRYPTION_CREDS"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with this cluster.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.