Class: AWS.DocDBElastic

var params = {
  adminUserName: 'STRING_VALUE', /* required */
  adminUserPassword: 'STRING_VALUE', /* required */
  authType: PLAIN_TEXT | SECRET_ARN, /* required */
  clusterName: 'STRING_VALUE', /* required */
  shardCapacity: 'NUMBER_VALUE', /* required */
  shardCount: 'NUMBER_VALUE', /* required */
  backupRetentionPeriod: 'NUMBER_VALUE',
  clientToken: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  preferredBackupWindow: 'STRING_VALUE',
  preferredMaintenanceWindow: 'STRING_VALUE',
  shardInstanceCount: 'NUMBER_VALUE',
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  vpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdbelastic.createCluster(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: {}) —
  • adminUserName — (String)

    The name of the Amazon DocumentDB elastic clusters administrator.

    Constraints:

    • Must be from 1 to 63 letters or numbers.

    • The first character must be a letter.

    • Cannot be a reserved word.

  • adminUserPassword — (String)

    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

    Constraints:

    • Must contain from 8 to 100 characters.

    • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

  • authType — (String)

    The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

    Possible values include:
    • "PLAIN_TEXT"
    • "SECRET_ARN"
  • backupRetentionPeriod — (Integer)

    The number of days for which automatic snapshots are retained.

  • clientToken — (String)

    The client token for the elastic cluster.

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

    The name of the new elastic cluster. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster

  • kmsKeyId — (String)

    The KMS key identifier to use to encrypt the new elastic 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, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

  • preferredBackupWindow — (String)

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

  • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

  • shardCount — (Integer)

    The number of shards assigned to the elastic cluster. Maximum is 32.

  • shardInstanceCount — (Integer)

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • subnetIds — (Array<String>)

    The Amazon EC2 subnet IDs for the new elastic cluster.

  • tags — (map<String>)

    The tags to be assigned to the new elastic cluster.

  • vpcSecurityGroupIds — (Array<String>)

    A list of EC2 VPC security groups to associate with the new elastic 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)

      The new elastic cluster that has been created.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic cluster.

Returns:

• (AWS.Request) —

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

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 identifier of the elastic cluster of which you want to create a snapshot.

  • snapshotName — (String)

    The name of the new elastic cluster snapshot.

  • tags — (map<String>)

    The tags to be assigned to the new elastic cluster 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 cluster snapshot.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterCreationTime — required — (String)

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

      • kmsKeyId — required — (String)

        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, Amazon 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 — required — (String)

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime — required — (String)

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the elastic cluster snapshot.

      • snapshotType — (String)

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        Possible values include:
        • "MANUAL"
        • "AUTOMATED"
      • status — required — (String)

        The status of the elastic cluster 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

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

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 identifier of the elastic 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic 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 identifier of the elastic cluster 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 cluster snapshot.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterCreationTime — required — (String)

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

      • kmsKeyId — required — (String)

        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, Amazon 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 — required — (String)

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime — required — (String)

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the elastic cluster snapshot.

      • snapshotType — (String)

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        Possible values include:
        • "MANUAL"
        • "AUTOMATED"
      • status — required — (String)

        The status of the elastic cluster 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

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

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 identifier of the elastic 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic 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 identifier of the elastic cluster 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 cluster snapshot.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterCreationTime — required — (String)

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

      • kmsKeyId — required — (String)

        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, Amazon 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 — required — (String)

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime — required — (String)

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the elastic cluster snapshot.

      • snapshotType — (String)

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        Possible values include:
        • "MANUAL"
        • "AUTOMATED"
      • status — required — (String)

        The status of the elastic cluster 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

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

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 elastic cluster snapshot results to receive in the response.

  • nextToken — (String)

    A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

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

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 Amazon DocumentDB elastic clusters.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
    • nextToken — (String)

      A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

      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',
  snapshotType: '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 identifier of the elastic cluster.

  • maxResults — (Integer)

    The maximum number of elastic cluster snapshot results to receive in the response.

  • nextToken — (String)

    A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

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

  • snapshotType — (String)

    The type of cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

    • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

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)

      A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

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

    • snapshots — (Array<map>)

      A list of snapshots for a specified elastic cluster.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • snapshotArn — required — (String)

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime — required — (String)

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName — required — (String)

        The name of the elastic cluster snapshot.

      • status — required — (String)

        The status of the elastic cluster 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"

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 identifier of the elastic cluster 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 cluster 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',
  shardCapacity: 'NUMBER_VALUE',
  shardInstanceCount: 'NUMBER_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 cluster.

  • kmsKeyId — (String)

    The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters 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, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

  • shardCapacity — (Integer)

    The capacity of each shard in the new restored elastic cluster.

  • shardInstanceCount — (Integer)

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • snapshotArn — (String)

    The ARN identifier of the elastic cluster snapshot.

  • subnetIds — (Array<String>)

    The Amazon EC2 subnet IDs for the elastic cluster.

  • tags — (map<String>)

    A list of the tag names to be assigned to the restored elastic 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 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic cluster.

Returns:

• (AWS.Request) —

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

var params = {
  clusterArn: 'STRING_VALUE' /* required */
};
docdbelastic.startCluster(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 identifier of the elastic 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic cluster.

Returns:

• (AWS.Request) —

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

var params = {
  clusterArn: 'STRING_VALUE' /* required */
};
docdbelastic.stopCluster(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 identifier of the elastic 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic 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 identifier of the elastic cluster resource.

  • tags — (map<String>)

    The tags that are assigned to the elastic cluster 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 identifier of the elastic cluster resource.

  • tagKeys — (Array<String>)

    The tag keys to be removed from the elastic cluster 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,
  backupRetentionPeriod: 'NUMBER_VALUE',
  clientToken: 'STRING_VALUE',
  preferredBackupWindow: 'STRING_VALUE',
  preferredMaintenanceWindow: 'STRING_VALUE',
  shardCapacity: 'NUMBER_VALUE',
  shardCount: 'NUMBER_VALUE',
  shardInstanceCount: '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 associated with the elastic 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 used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

    Possible values include:
    • "PLAIN_TEXT"
    • "SECRET_ARN"
  • backupRetentionPeriod — (Integer)

    The number of days for which automatic snapshots are retained.

  • clientToken — (String)

    The client token for the elastic cluster.

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

    The ARN identifier of the elastic cluster.

  • preferredBackupWindow — (String)

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

  • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

  • shardCount — (Integer)

    The number of shards assigned to the elastic cluster. Maximum is 32.

  • shardInstanceCount — (Integer)

    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • subnetIds — (Array<String>)

    The Amazon EC2 subnet IDs for the elastic cluster.

  • vpcSecurityGroupIds — (Array<String>)

    A list of EC2 VPC security groups to associate with the elastic 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 cluster.

      • adminUserName — required — (String)

        The name of the elastic cluster administrator.

      • authType — required — (String)

        The authentication type for the elastic cluster.

        Possible values include:
        • "PLAIN_TEXT"
        • "SECRET_ARN"
      • backupRetentionPeriod — (Integer)

        The number of days for which automatic snapshots are retained.

      • clusterArn — required — (String)

        The ARN identifier of the elastic cluster.

      • clusterEndpoint — required — (String)

        The URL used to connect to the elastic cluster.

      • clusterName — required — (String)

        The name of the elastic cluster.

      • createTime — required — (String)

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

      • kmsKeyId — required — (String)

        The KMS key identifier to use to encrypt the elastic cluster.

      • preferredBackupWindow — (String)

        The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

      • 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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      • shardCount — required — (Integer)

        The number of shards assigned to the elastic cluster. Maximum is 32.

      • shardInstanceCount — (Integer)

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards — (Array<map>)

        The total number of shards in the cluster.

        • createTime — required — (String)

          The time when the shard was created in Universal Coordinated Time (UTC).

        • shardId — required — (String)

          The ID of the shard.

        • status — required — (String)

          The current status of the shard.

          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"
          • "INACCESSIBLE_SECRET_ARN"
          • "INACCESSIBLE_VPC_ENDPOINT"
          • "INCOMPATIBLE_NETWORK"
          • "MERGING"
          • "MODIFYING"
          • "SPLITTING"
          • "COPYING"
          • "STARTING"
          • "STOPPING"
          • "STOPPED"
      • status — required — (String)

        The status of the elastic 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"
        • "INACCESSIBLE_SECRET_ARN"
        • "INACCESSIBLE_VPC_ENDPOINT"
        • "INCOMPATIBLE_NETWORK"
        • "MERGING"
        • "MODIFYING"
        • "SPLITTING"
        • "COPYING"
        • "STARTING"
        • "STOPPING"
        • "STOPPED"
      • subnetIds — required — (Array<String>)

        The Amazon EC2 subnet IDs for the elastic cluster.

      • vpcSecurityGroupIds — required — (Array<String>)

        A list of EC2 VPC security groups associated with thie elastic cluster.

Returns:

• (AWS.Request) —

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