We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.DocDBElastic

Inherits:
AWS.Service show all
Identifier:
docdbelastic
API Version:
2022-11-28
Defined in:
(unknown)

Overview

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

Service Description

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

Amazon DocumentDB elastic-clusters were created to:

  • provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.

  • give customers higher connection limits, and to reduce downtime from patching.

  • continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

Sending a Request Using DocDBElastic

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

Locking the API Version

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

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

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

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

var docdbelastic = new AWS.DocDBElastic();

Version:

  • 2022-11-28

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a DocDBElastic object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DocDBElastic.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DocDBElastic.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DocDBElastic.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Copies a snapshot of an elastic cluster.

Service Reference:

Examples:

Calling the copyClusterSnapshot operation

var params = {
  snapshotArn: 'STRING_VALUE', /* required */
  targetSnapshotName: 'STRING_VALUE', /* required */
  copyTags: true || false,
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
docdbelastic.copyClusterSnapshot(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: {})
    • copyTags — (Boolean)

      Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

    • kmsKeyId — (String)

      The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

      If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.

      To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

      If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

    • snapshotArn — (String)

      The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

    • tags — (map<String>)

      The tags to be assigned to the elastic cluster snapshot.

    • targetSnapshotName — (String)

      The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

      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: elastic-cluster-snapshot-5

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterCreationTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • snapshotArnrequired — (String)

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTimerequired — (String)

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

        • snapshotNamerequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

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

Service Reference:

Examples:

Calling the createCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Creates a snapshot of an elastic cluster.

Service Reference:

Examples:

Calling the createClusterSnapshot operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterCreationTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • snapshotArnrequired — (String)

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTimerequired — (String)

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

        • snapshotNamerequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Delete an elastic cluster.

Service Reference:

Examples:

Calling the deleteCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Delete an elastic cluster snapshot.

Service Reference:

Examples:

Calling the deleteClusterSnapshot operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterCreationTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • snapshotArnrequired — (String)

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTimerequired — (String)

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

        • snapshotNamerequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Returns information about a specific elastic cluster.

Service Reference:

Examples:

Calling the getCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Returns information about a specific elastic cluster snapshot

Service Reference:

Examples:

Calling the getClusterSnapshot operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterCreationTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • snapshotArnrequired — (String)

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTimerequired — (String)

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

        • snapshotNamerequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Returns information about provisioned Amazon DocumentDB elastic clusters.

Service Reference:

Examples:

Calling the listClusters operation

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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • statusrequired — (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.

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

Returns information about snapshots for a specified elastic cluster.

Service Reference:

Examples:

Calling the listClusterSnapshots operation

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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • snapshotArnrequired — (String)

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTimerequired — (String)

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

        • snapshotNamerequired — (String)

          The name of the elastic cluster snapshot.

        • statusrequired — (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.

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

Lists all tags on a elastic cluster resource

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

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

Restores an elastic cluster from a snapshot.

Service Reference:

Examples:

Calling the restoreClusterFromSnapshot operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Restarts the stopped elastic cluster that is specified by clusterARN.

Service Reference:

Examples:

Calling the startCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

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

Service Reference:

Examples:

Calling the stopCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.

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

Adds metadata tags to an elastic cluster resource

Service Reference:

Examples:

Calling the tagResource operation

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.

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

Removes metadata tags from an elastic cluster resource

Service Reference:

Examples:

Calling the untagResource operation

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.

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

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

Service Reference:

Examples:

Calling the updateCluster operation

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.

        • adminUserNamerequired — (String)

          The name of the elastic cluster administrator.

        • authTyperequired — (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.

        • clusterArnrequired — (String)

          The ARN identifier of the elastic cluster.

        • clusterEndpointrequired — (String)

          The URL used to connect to the elastic cluster.

        • clusterNamerequired — (String)

          The name of the elastic cluster.

        • createTimerequired — (String)

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

        • kmsKeyIdrequired — (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.

        • preferredMaintenanceWindowrequired — (String)

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

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

        • shardCapacityrequired — (Integer)

          The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

        • shardCountrequired — (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.

          • createTimerequired — (String)

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

          • shardIdrequired — (String)

            The ID of the shard.

          • statusrequired — (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"
        • statusrequired — (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"
        • subnetIdsrequired — (Array<String>)

          The Amazon EC2 subnet IDs for the elastic cluster.

        • vpcSecurityGroupIdsrequired — (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.