You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.DocDB

Inherits:
AWS.Service show all
Identifier:
docdb
API Version:
2014-10-31
Defined in:
(unknown)

Overview

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

Service Description

Amazon DocumentDB API documentation

Sending a Request Using DocDB

var docdb = new AWS.DocDB();
docdb.addSourceIdentifierToSubscription(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 DocDB object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var docdb = new AWS.DocDB({apiVersion: '2014-10-31'});

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

AWS.config.apiVersions = {
  docdb: '2014-10-31',
  // other service API versions
};

var docdb = new AWS.DocDB();

Version:

  • 2014-10-31

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

dBInstanceAvailable, dBInstanceDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

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

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

Examples:

Constructing a DocDB object

var docdb = new AWS.DocDB({apiVersion: '2014-10-31'});

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.DocDB.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.DocDB.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'.

Property Details

endpoint ⇒ AWS.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

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

Adds a source identifier to an existing event notification subscription.

Service Reference:

Examples:

Calling the addSourceIdentifierToSubscription operation

var params = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
docdb.addSourceIdentifierToSubscription(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: {}) —
    • SubscriptionName — (String)

      The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

    • SourceIdentifier — (String)

      The identifier of the event source to be added:

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

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:

      • EventSubscription — (map)

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

Service Reference:

Examples:

Calling the addTagsToResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.addTagsToResource(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: {}) —
    • ResourceName — (String)

      The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

    • Tags — (Array<map>)

      The tags to be assigned to the Amazon DocumentDB resource.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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.

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

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Service Reference:

Examples:

Calling the applyPendingMaintenanceAction operation

var params = {
  ApplyAction: 'STRING_VALUE', /* required */
  OptInType: 'STRING_VALUE', /* required */
  ResourceIdentifier: 'STRING_VALUE' /* required */
};
docdb.applyPendingMaintenanceAction(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: {}) —
    • ResourceIdentifier — (String)

      The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

    • ApplyAction — (String)

      The pending maintenance action to apply to this resource.

      Valid values: system-update, db-upgrade

    • OptInType — (String)

      A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

      Valid values:

      • immediate - Apply the maintenance action immediately.

      • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

      • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

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:

      • ResourcePendingMaintenanceActions — (map)

        Represents the output of ApplyPendingMaintenanceAction.

        • ResourceIdentifier — (String)

          The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

        • PendingMaintenanceActionDetails — (Array<map>)

          A list that provides details about the pending maintenance actions for the resource.

          • Action — (String)

            The type of pending maintenance action that is available for the resource.

          • AutoAppliedAfterDate — (Date)

            The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

          • ForcedApplyDate — (Date)

            The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

          • OptInStatus — (String)

            Indicates the type of opt-in request that has been received for the resource.

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action is applied to the resource.

          • Description — (String)

            A description providing more detail about the maintenance action.

Returns:

  • (AWS.Request) —

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

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

Copies the specified cluster parameter group.

Service Reference:

Examples:

Calling the copyDBClusterParameterGroup operation

var params = {
  SourceDBClusterParameterGroupIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterParameterGroupDescription: 'STRING_VALUE', /* required */
  TargetDBClusterParameterGroupIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.copyDBClusterParameterGroup(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: {}) —
    • SourceDBClusterParameterGroupIdentifier — (String)

      The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

      Constraints:

      • Must specify a valid cluster parameter group.

      • If the source cluster parameter group is in the same Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

      • If the source parameter group is in a different Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

    • TargetDBClusterParameterGroupIdentifier — (String)

      The identifier for the copied cluster parameter group.

      Constraints:

      • Cannot be null, empty, or blank.

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

      • The first character must be a letter.

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

      Example: my-cluster-param-group1

    • TargetDBClusterParameterGroupDescription — (String)

      A description for the copied cluster parameter group.

    • Tags — (Array<map>)

      The tags that are to be assigned to the parameter group.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterParameterGroup — (map)

        Detailed information about a cluster parameter group.

        • DBClusterParameterGroupName — (String)

          Provides the name of the cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the parameter group family that this cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the cluster parameter group.

Returns:

  • (AWS.Request) —

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

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

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

Service Reference:

Examples:

Calling the copyDBClusterSnapshot operation

var params = {
  SourceDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.copyDBClusterSnapshot(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: {}) —
    • SourceDBClusterSnapshotIdentifier — (String)

      The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

      Constraints:

      • Must specify a valid system snapshot in the available state.

      • If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.

      • If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

      Example: my-cluster-snapshot1

    • TargetDBClusterSnapshotIdentifier — (String)

      The identifier of the new 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: my-cluster-snapshot2

    • KmsKeyId — (String)

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

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

      If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

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

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

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

      If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Region.

      The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

      • SourceRegion - The ID of the region that contains the snapshot to be copied.

      • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

      • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

    • CopyTags — (Boolean)

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

    • Tags — (Array<map>)

      The tags to be assigned to the cluster snapshot.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterSnapshot — (map)

        Detailed information about a cluster snapshot.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in UTC.

        • Engine — (String)

          Specifies the name of the database engine.

        • Status — (String)

          Specifies the status of this cluster snapshot.

        • Port — (Integer)

          Specifies the port that the cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master user name for the cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Returns:

  • (AWS.Request) —

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

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

Creates a new Amazon DocumentDB cluster.

Service Reference:

Examples:

Calling the createDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BackupRetentionPeriod: 'NUMBER_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  StorageEncrypted: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.createDBCluster(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: {}) —
    • AvailabilityZones — (Array<String>)

      A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

    • DBClusterIdentifier — (String)

      The cluster identifier. 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

    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group to associate with this cluster.

    • VpcSecurityGroupIds — (Array<String>)

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

    • DBSubnetGroupName — (String)

      A subnet group to associate with this cluster.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • Engine — (String)

      The name of the database engine to be used for this cluster.

      Valid values: docdb

    • EngineVersion — (String)

      The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

    • Port — (Integer)

      The port number on which the instances in the cluster accept connections.

    • MasterUsername — (String)

      The name of the master user for the cluster.

      Constraints:

      • Must be from 1 to 63 letters or numbers.

      • The first character must be a letter.

      • Cannot be a reserved word for the chosen database engine.

    • MasterUserPassword — (String)

      The password for the master database user. 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.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • PreferredMaintenanceWindow — (String)

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

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

      The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

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

      Constraints: Minimum 30-minute window.

    • Tags — (Array<map>)

      The tags to be assigned to the cluster.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • StorageEncrypted — (Boolean)

      Specifies whether the cluster is encrypted.

    • KmsKeyId — (String)

      The KMS key identifier for an encrypted 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 account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If an encryption key is not specified in KmsKeyId:

      • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

      KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.

    • PreSignedUrl — (String)

      Not currently supported.

    • EnableCloudwatchLogsExports — (Array<String>)

      A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

    • DeletionProtection — (Boolean)

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    • GlobalClusterIdentifier — (String)

      The cluster identifier of the new global 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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

Service Reference:

Examples:

Calling the createDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.createDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group.

      Constraints:

      • Must not match the name of an existing DBClusterParameterGroup.

      Note: This value is stored as a lowercase string.
    • DBParameterGroupFamily — (String)

      The cluster parameter group family name.

    • Description — (String)

      The description for the cluster parameter group.

    • Tags — (Array<map>)

      The tags to be assigned to the cluster parameter group.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterParameterGroup — (map)

        Detailed information about a cluster parameter group.

        • DBClusterParameterGroupName — (String)

          Provides the name of the cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the parameter group family that this cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the cluster parameter group.

Returns:

  • (AWS.Request) —

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

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

Creates a snapshot of a cluster.

Service Reference:

Examples:

Calling the createDBClusterSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.createDBClusterSnapshot(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier of the cluster snapshot. 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-snapshot1

    • DBClusterIdentifier — (String)

      The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Example: my-cluster

    • Tags — (Array<map>)

      The tags to be assigned to the cluster snapshot.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterSnapshot — (map)

        Detailed information about a cluster snapshot.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in UTC.

        • Engine — (String)

          Specifies the name of the database engine.

        • Status — (String)

          Specifies the status of this cluster snapshot.

        • Port — (Integer)

          Specifies the port that the cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master user name for the cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Returns:

  • (AWS.Request) —

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

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

Creates a new instance.

Service Reference:

Examples:

Calling the createDBInstance operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBInstanceClass: 'STRING_VALUE', /* required */
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.createDBInstance(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: {}) —
    • DBInstanceIdentifier — (String)

      The instance identifier. 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: mydbinstance

    • DBInstanceClass — (String)

      The compute and memory capacity of the instance; for example, db.r5.large.

    • Engine — (String)

      The name of the database engine to be used for this instance.

      Valid value: docdb

    • AvailabilityZone — (String)

      The Amazon EC2 Availability Zone that the instance is created in.

      Default: A random, system-chosen Availability Zone in the endpoint's Region.

      Example: us-east-1d

    • PreferredMaintenanceWindow — (String)

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

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

      The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

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

      Constraints: Minimum 30-minute window.

    • AutoMinorVersionUpgrade — (Boolean)

      This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

      Default: false

    • Tags — (Array<map>)

      The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • DBClusterIdentifier — (String)

      The identifier of the cluster that the instance will belong to.

    • PromotionTier — (Integer)

      A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

      Default: 1

      Valid values: 0-15

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:

      • DBInstance — (map)

        Detailed information about an instance.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

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

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.

Service Reference:

Examples:

Calling the createDBSubnetGroup operation

var params = {
  DBSubnetGroupDescription: 'STRING_VALUE', /* required */
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.createDBSubnetGroup(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: {}) —
    • DBSubnetGroupName — (String)

      The name for the subnet group. This value is stored as a lowercase string.

      Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

      Example: mySubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the subnet group.

    • SubnetIds — (Array<String>)

      The Amazon EC2 subnet IDs for the subnet group.

    • Tags — (Array<map>)

      The tags to be assigned to the subnet group.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBSubnetGroup — (map)

        Detailed information about a subnet group.

        • DBSubnetGroupName — (String)

          The name of the subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the subnet group.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID of the subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the subnet group.

        • Subnets — (Array<map>)

          Detailed information about one or more subnets within a subnet group.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the Availability Zone for the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

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

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

Service Reference:

Examples:

Calling the createEventSubscription operation

var params = {
  SnsTopicArn: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.createEventSubscription(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: {}) —
    • SubscriptionName — (String)

      The name of the subscription.

      Constraints: The name must be fewer than 255 characters.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

      Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

    • EventCategories — (Array<String>)

      A list of event categories for a SourceType that you want to subscribe to.

    • SourceIds — (Array<String>)

      The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

      Constraints:

      • If SourceIds are provided, SourceType must also be provided.

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

    • Enabled — (Boolean)

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    • Tags — (Array<map>)

      The tags to be assigned to the event subscription.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • EventSubscription — (map)

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

Note: This action only applies to Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the createGlobalCluster operation

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  SourceDBClusterIdentifier: 'STRING_VALUE',
  StorageEncrypted: true || false
};
docdb.createGlobalCluster(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: {}) —
    • GlobalClusterIdentifier — (String)

      The cluster identifier of the new global cluster.

    • SourceDBClusterIdentifier — (String)

      The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

    • Engine — (String)

      The name of the database engine to be used for this cluster.

    • EngineVersion — (String)

      The engine version of the global cluster.

    • DeletionProtection — (Boolean)

      The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

    • DatabaseName — (String)

      The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

    • StorageEncrypted — (Boolean)

      The storage encryption setting for the new global 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:

      • GlobalCluster — (map)

        A data type representing an Amazon DocumentDB global cluster.

        • GlobalClusterIdentifier — (String)

          Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

        • GlobalClusterResourceId — (String)

          The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

        • GlobalClusterArn — (String)

          The Amazon Resource Name (ARN) for the global cluster.

        • Status — (String)

          Specifies the current state of this global cluster.

        • Engine — (String)

          The Amazon DocumentDB database engine used by the global cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • IsWriter — (Boolean)

            Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Returns:

  • (AWS.Request) —

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

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

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

Service Reference:

Examples:

Calling the deleteDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
docdb.deleteDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

      Constraints:

      • Must match an existing DBClusterIdentifier.

    • SkipFinalSnapshot — (Boolean)

      Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

      Note: If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

      Default: false

    • FinalDBSnapshotIdentifier — (String)

      The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

      Note: Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

      Constraints:

      • Must be from 1 to 255 letters, numbers, or hyphens.

      • The first character must be a letter.

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

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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

Service Reference:

Examples:

Calling the deleteDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE' /* required */
};
docdb.deleteDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group.

      Constraints:

      • Must be the name of an existing cluster parameter group.

      • You can't delete a default cluster parameter group.

      • Cannot be associated with any clusters.

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.

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

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

Note: The cluster snapshot must be in the available state to be deleted.

Service Reference:

Examples:

Calling the deleteDBClusterSnapshot operation

var params = {
  DBClusterSnapshotIdentifier: 'STRING_VALUE' /* required */
};
docdb.deleteDBClusterSnapshot(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier of the cluster snapshot to delete.

      Constraints: Must be the name of an existing cluster snapshot in the available state.

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:

      • DBClusterSnapshot — (map)

        Detailed information about a cluster snapshot.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in UTC.

        • Engine — (String)

          Specifies the name of the database engine.

        • Status — (String)

          Specifies the status of this cluster snapshot.

        • Port — (Integer)

          Specifies the port that the cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master user name for the cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Returns:

  • (AWS.Request) —

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

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

Deletes a previously provisioned instance.

Service Reference:

Examples:

Calling the deleteDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE' /* required */
};
docdb.deleteDBInstance(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: {}) —
    • DBInstanceIdentifier — (String)

      The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

      Constraints:

      • Must match the name of an existing instance.

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:

      • DBInstance — (map)

        Detailed information about an instance.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

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

Deletes a subnet group.

Note: The specified database subnet group must not be associated with any DB instances.

Service Reference:

Examples:

Calling the deleteDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE' /* required */
};
docdb.deleteDBSubnetGroup(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: {}) —
    • DBSubnetGroupName — (String)

      The name of the database subnet group to delete.

      Note: You can't delete the default subnet group.

      Constraints:

      Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

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.

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

Deletes an Amazon DocumentDB event notification subscription.

Service Reference:

Examples:

Calling the deleteEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE' /* required */
};
docdb.deleteEventSubscription(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: {}) —
    • SubscriptionName — (String)

      The name of the Amazon DocumentDB event notification subscription that you want to delete.

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:

      • EventSubscription — (map)

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

Note: This action only applies to Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the deleteGlobalCluster operation

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE' /* required */
};
docdb.deleteGlobalCluster(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: {}) —
    • GlobalClusterIdentifier — (String)

      The cluster identifier of the global cluster being 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:

      • GlobalCluster — (map)

        A data type representing an Amazon DocumentDB global cluster.

        • GlobalClusterIdentifier — (String)

          Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

        • GlobalClusterResourceId — (String)

          The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

        • GlobalClusterArn — (String)

          The Amazon Resource Name (ARN) for the global cluster.

        • Status — (String)

          Specifies the current state of this global cluster.

        • Engine — (String)

          The Amazon DocumentDB database engine used by the global cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • IsWriter — (Boolean)

            Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Returns:

  • (AWS.Request) —

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

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

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.

Service Reference:

Examples:

Calling the describeCertificates operation

var params = {
  CertificateIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeCertificates(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: {}) —
    • CertificateIdentifier — (String)

      The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

      Constraints

      • Must match an existing CertificateIdentifier.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints:

      • Minimum: 20

      • Maximum: 100

    • Marker — (String)

      An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Certificates — (Array<map>)

        A list of certificates for this account.

        • CertificateIdentifier — (String)

          The unique key that identifies a certificate.

          Example: rds-ca-2019

        • CertificateType — (String)

          The type of the certificate.

          Example: CA

        • Thumbprint — (String)

          The thumbprint of the certificate.

        • ValidFrom — (Date)

          The starting date-time from which the certificate is valid.

          Example: 2019-07-31T17:57:09Z

        • ValidTill — (Date)

          The date-time after which the certificate is no longer valid.

          Example: 2024-07-31T17:57:09Z

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) for the certificate.

          Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

      • Marker — (String)

        An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

Returns:

  • (AWS.Request) —

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

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

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

Service Reference:

Examples:

Calling the describeDBClusterParameterGroups operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeDBClusterParameterGroups(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of a specific cluster parameter group to return details for.

      Constraints:

      • If provided, must match the name of an existing DBClusterParameterGroup.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterParameterGroups — (Array<map>)

        A list of cluster parameter groups.

        • DBClusterParameterGroupName — (String)

          Provides the name of the cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the parameter group family that this cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the cluster parameter group.

Returns:

  • (AWS.Request) —

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

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

Returns the detailed parameter list for a particular cluster parameter group.

Service Reference:

Examples:

Calling the describeDBClusterParameters operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
docdb.describeDBClusterParameters(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of a specific cluster parameter group to return parameter details for.

      Constraints:

      • If provided, must match the name of an existing DBClusterParameterGroup.

    • Source — (String)

      A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Parameters — (Array<map>)

        Provides a list of parameters for the cluster parameter group.

        • ParameterName — (String)

          Specifies the name of the parameter.

        • ParameterValue — (String)

          Specifies the value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          Indicates the source of the parameter value.

        • ApplyType — (String)

          Specifies the engine-specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

          Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (AWS.Request) —

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

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

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the describeDBClusters operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeDBClusters(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: {}) —
    • DBClusterIdentifier — (String)

      The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

      Constraints:

      • If provided, must match an existing DBClusterIdentifier.

    • Filters — (Array<map>)

      A filter that specifies one or more clusters to describe.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusters — (Array<map>)

        A list of clusters.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts.

Service Reference:

Examples:

Calling the describeDBClusterSnapshotAttributes operation

var params = {
  DBClusterSnapshotIdentifier: 'STRING_VALUE' /* required */
};
docdb.describeDBClusterSnapshotAttributes(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier for the cluster snapshot to describe the attributes for.

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:

      • DBClusterSnapshotAttributesResult — (map)

        Detailed information about the attributes that are associated with a cluster snapshot.

        • DBClusterSnapshotIdentifier — (String)

          The identifier of the cluster snapshot that the attributes apply to.

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the cluster snapshot.

          • AttributeName — (String)

            The name of the manual cluster snapshot attribute.

            The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

          • AttributeValues — (Array<String>)

            The values for the manual cluster snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

Returns:

  • (AWS.Request) —

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

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

Returns information about cluster snapshots. This API operation supports pagination.

Service Reference:

Examples:

Calling the describeDBClusterSnapshots operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  DBClusterSnapshotIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublic: true || false,
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SnapshotType: 'STRING_VALUE'
};
docdb.describeDBClusterSnapshots(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: {}) —
    • DBClusterIdentifier — (String)

      The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBCluster.

    • DBClusterSnapshotIdentifier — (String)

      A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • If provided, must match the identifier of an existing DBClusterSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • 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 account.

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

      • shared - Return all manual cluster snapshots that have been shared to your account.

      • public - Return all cluster snapshots that have been marked as public.

      If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.

    • IncludePublic — (Boolean)

      Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterSnapshots — (Array<map>)

        Provides a list of cluster snapshots.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in UTC.

        • Engine — (String)

          Specifies the name of the database engine.

        • Status — (String)

          Specifies the status of this cluster snapshot.

        • Port — (Integer)

          Specifies the port that the cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master user name for the cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the available engines.

Service Reference:

Examples:

Calling the describeDBEngineVersions operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE',
  DefaultOnly: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ListSupportedCharacterSets: true || false,
  ListSupportedTimezones: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeDBEngineVersions(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: {}) —
    • Engine — (String)

      The database engine to return.

    • EngineVersion — (String)

      The database engine version to return.

      Example: 3.6.0

    • DBParameterGroupFamily — (String)

      The name of a specific parameter group family to return details for.

      Constraints:

      • If provided, must match an existing DBParameterGroupFamily.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • DefaultOnly — (Boolean)

      Indicates that only the default version of the specified engine or engine and major version combination is returned.

    • ListSupportedCharacterSets — (Boolean)

      If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    • ListSupportedTimezones — (Boolean)

      If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBEngineVersions — (Array<map>)

        Detailed information about one or more engine versions.

        • Engine — (String)

          The name of the database engine.

        • EngineVersion — (String)

          The version number of the database engine.

        • DBParameterGroupFamily — (String)

          The name of the parameter group family for the database engine.

        • DBEngineDescription — (String)

          The description of the database engine.

        • DBEngineVersionDescription — (String)

          The description of the database engine version.

        • ValidUpgradeTarget — (Array<map>)

          A list of engine versions that this database engine version can be upgraded to.

          • Engine — (String)

            The name of the upgrade target database engine.

          • EngineVersion — (String)

            The version number of the upgrade target database engine.

          • Description — (String)

            The version of the database engine that an instance can be upgraded to.

          • AutoUpgrade — (Boolean)

            A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

          • IsMajorVersionUpgrade — (Boolean)

            A value that indicates whether a database engine is upgraded to a major version.

        • ExportableLogTypes — (Array<String>)

          The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

        • SupportsLogExportsToCloudwatchLogs — (Boolean)

          A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

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

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

Service Reference:

Examples:

Calling the describeDBInstances operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeDBInstances(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: {}) —
    • DBInstanceIdentifier — (String)

      The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more instances to describe.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

      • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBInstances — (Array<map>)

        Detailed information about one or more instances.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Service Reference:

Examples:

Calling the describeDBSubnetGroups operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeDBSubnetGroups(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: {}) —
    • DBSubnetGroupName — (String)

      The name of the subnet group to return details for.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBSubnetGroups — (Array<map>)

        Detailed information about one or more subnet groups.

        • DBSubnetGroupName — (String)

          The name of the subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the subnet group.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID of the subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the subnet group.

        • Subnets — (Array<map>)

          Detailed information about one or more subnets within a subnet group.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the Availability Zone for the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

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

Returns the default engine and system parameter information for the cluster database engine.

Service Reference:

Examples:

Calling the describeEngineDefaultClusterParameters operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeEngineDefaultClusterParameters(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: {}) —
    • DBParameterGroupFamily — (String)

      The name of the cluster parameter group family to return the engine parameter information for.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • EngineDefaults — (map)

        Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

        • DBParameterGroupFamily — (String)

          The name of the cluster parameter group family to return the engine parameter information for.

        • Marker — (String)

          An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

        • Parameters — (Array<map>)

          The parameters of a particular cluster parameter group family.

          • ParameterName — (String)

            Specifies the name of the parameter.

          • ParameterValue — (String)

            Specifies the value of the parameter.

          • Description — (String)

            Provides a description of the parameter.

          • Source — (String)

            Indicates the source of the parameter value.

          • ApplyType — (String)

            Specifies the engine-specific parameters type.

          • DataType — (String)

            Specifies the valid data type for the parameter.

          • AllowedValues — (String)

            Specifies the valid range of values for the parameter.

          • IsModifiable — (Boolean)

            Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

          • ApplyMethod — (String)

            Indicates when to apply parameter updates.

            Possible values include:
            • "immediate"
            • "pending-reboot"

Returns:

  • (AWS.Request) —

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

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

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Service Reference:

Examples:

Calling the describeEventCategories operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  SourceType: 'STRING_VALUE'
};
docdb.describeEventCategories(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: {}) —
    • SourceType — (String)

      The type of source that is generating the events.

      Valid values: db-instance, db-parameter-group, db-security-group

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

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:

      • EventCategoriesMapList — (Array<map>)

        A list of event category maps.

        • SourceType — (String)

          The source type that the returned categories belong to.

        • EventCategories — (Array<String>)

          The event categories for the specified source type.

Returns:

  • (AWS.Request) —

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

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

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 'NUMBER_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceIdentifier: 'STRING_VALUE',
  SourceType: db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
docdb.describeEvents(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: {}) —
    • SourceIdentifier — (String)

      The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

      Constraints:

      • If SourceIdentifier is provided, SourceType must also be provided.

      • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

      • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

      • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

      • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

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

    • SourceType — (String)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Possible values include:
      • "db-instance"
      • "db-parameter-group"
      • "db-security-group"
      • "db-snapshot"
      • "db-cluster"
      • "db-cluster-snapshot"
    • StartTime — (Date)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

      Example: 2009-07-08T18:00Z

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format.

      Example: 2009-07-08T18:00Z

    • Duration — (Integer)

      The number of minutes to retrieve events for.

      Default: 60

    • EventCategories — (Array<String>)

      A list of event categories that trigger notifications for an event notification subscription.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • Events — (Array<map>)

        Detailed information about one or more events.

        • SourceIdentifier — (String)

          Provides the identifier for the source of the event.

        • SourceType — (String)

          Specifies the source type for this event.

          Possible values include:
          • "db-instance"
          • "db-parameter-group"
          • "db-security-group"
          • "db-snapshot"
          • "db-cluster"
          • "db-cluster-snapshot"
        • Message — (String)

          Provides the text of this event.

        • EventCategories — (Array<String>)

          Specifies the category for the event.

        • Date — (Date)

          Specifies the date and time of the event.

        • SourceArn — (String)

          The Amazon Resource Name (ARN) for the event.

Returns:

  • (AWS.Request) —

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

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

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Service Reference:

Examples:

Calling the describeEventSubscriptions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SubscriptionName: 'STRING_VALUE'
};
docdb.describeEventSubscriptions(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: {}) —
    • SubscriptionName — (String)

      The name of the Amazon DocumentDB event notification subscription that you want to describe.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • EventSubscriptionsList — (Array<map>)

        A list of event subscriptions.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

Note: This action only applies to Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the describeGlobalClusters operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GlobalClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
docdb.describeGlobalClusters(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: {}) —
    • GlobalClusterIdentifier — (String)

      The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

    • Filters — (Array<map>)

      A filter that specifies one or more global DB clusters to describe.

      Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

      • GlobalClusters — (Array<map>)

        • GlobalClusterIdentifier — (String)

          Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

        • GlobalClusterResourceId — (String)

          The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

        • GlobalClusterArn — (String)

          The Amazon Resource Name (ARN) for the global cluster.

        • Status — (String)

          Specifies the current state of this global cluster.

        • Engine — (String)

          The Amazon DocumentDB database engine used by the global cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • IsWriter — (Boolean)

            Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Returns:

  • (AWS.Request) —

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

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

Returns a list of orderable instance options for the specified engine.

Service Reference:

Examples:

Calling the describeOrderableDBInstanceOptions operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  DBInstanceClass: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseModel: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Vpc: true || false
};
docdb.describeOrderableDBInstanceOptions(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: {}) —
    • Engine — (String)

      The name of the engine to retrieve instance options for.

    • EngineVersion — (String)

      The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

    • DBInstanceClass — (String)

      The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

    • LicenseModel — (String)

      The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

    • Vpc — (Boolean)

      The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • OrderableDBInstanceOptions — (Array<map>)

        The options that are available for a particular orderable instance.

        • Engine — (String)

          The engine type of an instance.

        • EngineVersion — (String)

          The engine version of an instance.

        • DBInstanceClass — (String)

          The instance class for an instance.

        • LicenseModel — (String)

          The license model for an instance.

        • AvailabilityZones — (Array<map>)

          A list of Availability Zones for an instance.

          • Name — (String)

            The name of the Availability Zone.

        • Vpc — (Boolean)

          Indicates whether an instance is in a virtual private cloud (VPC).

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (AWS.Request) —

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

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

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

Service Reference:

Examples:

Calling the describePendingMaintenanceActions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ResourceIdentifier: 'STRING_VALUE'
};
docdb.describePendingMaintenanceActions(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: {}) —
    • ResourceIdentifier — (String)

      The ARN of a resource to return pending maintenance actions for.

    • Filters — (Array<map>)

      A filter that specifies one or more resources to return pending maintenance actions for.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.

      • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

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:

      • PendingMaintenanceActions — (Array<map>)

        The maintenance actions to be applied.

        • ResourceIdentifier — (String)

          The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

        • PendingMaintenanceActionDetails — (Array<map>)

          A list that provides details about the pending maintenance actions for the resource.

          • Action — (String)

            The type of pending maintenance action that is available for the resource.

          • AutoAppliedAfterDate — (Date)

            The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

          • ForcedApplyDate — (Date)

            The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

          • OptInStatus — (String)

            Indicates the type of opt-in request that has been received for the resource.

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action is applied to the resource.

          • Description — (String)

            A description providing more detail about the maintenance action.

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (AWS.Request) —

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

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

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Service Reference:

Examples:

Calling the failoverDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  TargetDBInstanceIdentifier: 'STRING_VALUE'
};
docdb.failoverDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      A cluster identifier to force a failover for. This parameter is not case sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • TargetDBInstanceIdentifier — (String)

      The name of the instance to promote to the primary instance.

      You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Lists all tags on an Amazon DocumentDB resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
docdb.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: {}) —
    • ResourceName — (String)

      The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

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:

      • TagList — (Array<map>)

        A list of one or more tags.

        • Key — (String)

          The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

        • Value — (String)

          The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Returns:

  • (AWS.Request) —

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

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

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Service Reference:

Examples:

Calling the modifyDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CloudwatchLogsExportConfiguration: {
    DisableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ],
    EnableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  DBClusterParameterGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EngineVersion: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  NewDBClusterIdentifier: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.modifyDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • NewDBClusterIdentifier — (String)

      The new cluster identifier for the cluster when renaming a cluster. This value 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-cluster2

    • ApplyImmediately — (Boolean)

      A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

      The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

      Default: false

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35.

    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group to use for the cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of virtual private cloud (VPC) security groups that the cluster will belong to.

    • Port — (Integer)

      The port number on which the cluster accepts connections.

      Constraints: Must be a value from 1150 to 65535.

      Default: The same port as the original cluster.

    • MasterUserPassword — (String)

      The password for the master database user. 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.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • PreferredMaintenanceWindow — (String)

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

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

      The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

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

      Constraints: Minimum 30-minute window.

    • CloudwatchLogsExportConfiguration — (map)

      The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

      • EnableLogTypes — (Array<String>)

        The list of log types to enable.

      • DisableLogTypes — (Array<String>)

        The list of log types to disable.

    • EngineVersion — (String)

      The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

    • DeletionProtection — (Boolean)

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally 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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

Service Reference:

Examples:

Calling the modifyDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [ /* required */
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ]
};
docdb.modifyDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group to modify.

    • Parameters — (Array<map>)

      A list of parameters in the cluster parameter group to modify.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine-specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"

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:

      • DBClusterParameterGroupName — (String)

        The name of a cluster parameter group.

        Constraints:

        • Must be from 1 to 255 letters or numbers.

        • The first character must be a letter.

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

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

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

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

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

Service Reference:

Examples:

Calling the modifyDBClusterSnapshotAttribute operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  ValuesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  ValuesToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.modifyDBClusterSnapshotAttribute(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier for the cluster snapshot to modify the attributes for.

    • AttributeName — (String)

      The name of the cluster snapshot attribute to modify.

      To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.

    • ValuesToAdd — (Array<String>)

      A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.

    • ValuesToRemove — (Array<String>)

      A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual 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:

      • DBClusterSnapshotAttributesResult — (map)

        Detailed information about the attributes that are associated with a cluster snapshot.

        • DBClusterSnapshotIdentifier — (String)

          The identifier of the cluster snapshot that the attributes apply to.

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the cluster snapshot.

          • AttributeName — (String)

            The name of the manual cluster snapshot attribute.

            The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

          • AttributeValues — (Array<String>)

            The values for the manual cluster snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

Returns:

  • (AWS.Request) —

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

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

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Service Reference:

Examples:

Calling the modifyDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  AutoMinorVersionUpgrade: true || false,
  CACertificateIdentifier: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  NewDBInstanceIdentifier: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 'NUMBER_VALUE'
};
docdb.modifyDBInstance(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: {}) —
    • DBInstanceIdentifier — (String)

      The instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • DBInstanceClass — (String)

      The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.

      If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting.

    • ApplyImmediately — (Boolean)

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

      If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

      Default: false

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

      Default: Uses existing setting.

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

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

      Constraints: Must be at least 30 minutes.

    • AutoMinorVersionUpgrade — (Boolean)

      This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    • NewDBInstanceIdentifier — (String)

      The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value 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: mydbinstance

    • CACertificateIdentifier — (String)

      Indicates the certificate that needs to be associated with the instance.

    • PromotionTier — (Integer)

      A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

      Default: 1

      Valid values: 0-15

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:

      • DBInstance — (map)

        Detailed information about an instance.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

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

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.

Service Reference:

Examples:

Calling the modifyDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupDescription: 'STRING_VALUE'
};
docdb.modifyDBSubnetGroup(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: {}) —
    • DBSubnetGroupName — (String)

      The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the subnet group.

    • SubnetIds — (Array<String>)

      The Amazon EC2 subnet IDs for the subnet group.

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:

      • DBSubnetGroup — (map)

        Detailed information about a subnet group.

        • DBSubnetGroupName — (String)

          The name of the subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the subnet group.

        • VpcId — (String)

          Provides the virtual private cloud (VPC) ID of the subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the subnet group.

        • Subnets — (Array<map>)

          Detailed information about one or more subnets within a subnet group.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the Availability Zone for the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

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

Modifies an existing Amazon DocumentDB event notification subscription.

Service Reference:

Examples:

Calling the modifyEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  SnsTopicArn: 'STRING_VALUE',
  SourceType: 'STRING_VALUE'
};
docdb.modifyEventSubscription(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: {}) —
    • SubscriptionName — (String)

      The name of the Amazon DocumentDB event notification subscription.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

      Valid values: db-instance, db-parameter-group, db-security-group

    • EventCategories — (Array<String>)

      A list of event categories for a SourceType that you want to subscribe to.

    • Enabled — (Boolean)

      A Boolean value; set to true to activate the subscription.

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:

      • EventSubscription — (map)

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

Note: This action only applies to Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the modifyGlobalCluster operation

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE', /* required */
  DeletionProtection: true || false,
  NewGlobalClusterIdentifier: 'STRING_VALUE'
};
docdb.modifyGlobalCluster(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: {}) —
    • GlobalClusterIdentifier — (String)

      The identifier for the global cluster being modified. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing global cluster.

    • NewGlobalClusterIdentifier — (String)

      The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

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

        The first character must be a letter

        Can't end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • DeletionProtection — (Boolean)

      Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

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:

      • GlobalCluster — (map)

        A data type representing an Amazon DocumentDB global cluster.

        • GlobalClusterIdentifier — (String)

          Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

        • GlobalClusterResourceId — (String)

          The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

        • GlobalClusterArn — (String)

          The Amazon Resource Name (ARN) for the global cluster.

        • Status — (String)

          Specifies the current state of this global cluster.

        • Engine — (String)

          The Amazon DocumentDB database engine used by the global cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • IsWriter — (Boolean)

            Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Returns:

  • (AWS.Request) —

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

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

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.

Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

Service Reference:

Examples:

Calling the rebootDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  ForceFailover: true || false
};
docdb.rebootDBInstance(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: {}) —
    • DBInstanceIdentifier — (String)

      The instance identifier. This parameter is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • ForceFailover — (Boolean)

      When true, the reboot is conducted through a Multi-AZ failover.

      Constraint: You can't specify true if the instance is not configured for Multi-AZ.

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:

      • DBInstance — (map)

        Detailed information about an instance.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

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

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

Note: This action only applies to Amazon DocumentDB clusters.

Service Reference:

Examples:

Calling the removeFromGlobalCluster operation

var params = {
  DbClusterIdentifier: 'STRING_VALUE', /* required */
  GlobalClusterIdentifier: 'STRING_VALUE' /* required */
};
docdb.removeFromGlobalCluster(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: {}) —
    • GlobalClusterIdentifier — (String)

      The cluster identifier to detach from the Amazon DocumentDB global cluster.

    • DbClusterIdentifier — (String)

      The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global 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:

      • GlobalCluster — (map)

        A data type representing an Amazon DocumentDB global cluster.

        • GlobalClusterIdentifier — (String)

          Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

        • GlobalClusterResourceId — (String)

          The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

        • GlobalClusterArn — (String)

          The Amazon Resource Name (ARN) for the global cluster.

        • Status — (String)

          Specifies the current state of this global cluster.

        • Engine — (String)

          The Amazon DocumentDB database engine used by the global cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

          • IsWriter — (Boolean)

            Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

Returns:

  • (AWS.Request) —

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

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

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

Service Reference:

Examples:

Calling the removeSourceIdentifierFromSubscription operation

var params = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
docdb.removeSourceIdentifierFromSubscription(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: {}) —
    • SubscriptionName — (String)

      The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

    • SourceIdentifier — (String)

      The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

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:

      • EventSubscription — (map)

        Detailed information about an event to which you have subscribed.

        • CustomerAwsId — (String)

          The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

        • CustSubscriptionId — (String)

          The Amazon DocumentDB event notification subscription ID.

        • SnsTopicArn — (String)

          The topic ARN of the Amazon DocumentDB event notification subscription.

        • Status — (String)

          The status of the Amazon DocumentDB event notification subscription.

          Constraints:

          Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

          The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time at which the Amazon DocumentDB event notification subscription was created.

        • SourceType — (String)

          The source type for the Amazon DocumentDB event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the Amazon DocumentDB event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the Amazon DocumentDB event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

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

Removes metadata tags from an Amazon DocumentDB resource.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.removeTagsFromResource(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: {}) —
    • ResourceName — (String)

      The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

    • TagKeys — (Array<String>)

      The tag key (name) of the tag to be removed.

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.

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

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Service Reference:

Examples:

Calling the resetDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
docdb.resetDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the cluster parameter group to reset.

    • ResetAllParameters — (Boolean)

      A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

    • Parameters — (Array<map>)

      A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine-specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"

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:

      • DBClusterParameterGroupName — (String)

        The name of a cluster parameter group.

        Constraints:

        • Must be from 1 to 255 letters or numbers.

        • The first character must be a letter.

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

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

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

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

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Service Reference:

Examples:

Calling the restoreDBClusterFromSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.restoreDBClusterFromSnapshot(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: {}) —
    • AvailabilityZones — (Array<String>)

      Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

    • DBClusterIdentifier — (String)

      The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't 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: my-snapshot-id

    • SnapshotIdentifier — (String)

      The identifier for the snapshot or cluster snapshot to restore from.

      You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

      Constraints:

      • Must match the identifier of an existing snapshot.

    • Engine — (String)

      The database engine to use for the new cluster.

      Default: The same as source.

      Constraint: Must be compatible with the engine of the source.

    • EngineVersion — (String)

      The version of the database engine to use for the new cluster.

    • Port — (Integer)

      The port number on which the new cluster accepts connections.

      Constraints: Must be a value from 1150 to 65535.

      Default: The same port as the original cluster.

    • DBSubnetGroupName — (String)

      The name of the subnet group to use for the new cluster.

      Constraints: If provided, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • VpcSecurityGroupIds — (Array<String>)

      A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

    • Tags — (Array<map>)

      The tags to be assigned to the restored cluster.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • KmsKeyId — (String)

      The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If you do not specify a value for the KmsKeyId parameter, then the following occurs:

      • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

      • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

    • EnableCloudwatchLogsExports — (Array<String>)

      A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    • DeletionProtection — (Boolean)

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally 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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

Service Reference:

Examples:

Calling the restoreDBClusterToPointInTime operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  SourceDBClusterIdentifier: 'STRING_VALUE', /* required */
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  KmsKeyId: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  RestoreToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseLatestRestorableTime: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
docdb.restoreDBClusterToPointInTime(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: {}) —
    • DBClusterIdentifier — (String)

      The name of the new cluster to be created.

      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.

    • SourceDBClusterIdentifier — (String)

      The identifier of the source cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • RestoreToTime — (Date)

      The date and time to restore the cluster to.

      Valid values: A time in Universal Coordinated Time (UTC) format.

      Constraints:

      • Must be before the latest restorable time for the instance.

      • Must be specified if the UseLatestRestorableTime parameter is not provided.

      • Cannot be specified if the UseLatestRestorableTime parameter is true.

      • Cannot be specified if the RestoreType parameter is copy-on-write.

      Example: 2015-03-07T23:45:00Z

    • UseLatestRestorableTime — (Boolean)

      A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

      Default: false

      Constraints: Cannot be specified if the RestoreToTime parameter is provided.

    • Port — (Integer)

      The port number on which the new cluster accepts connections.

      Constraints: Must be a value from 1150 to 65535.

      Default: The default port for the engine.

    • DBSubnetGroupName — (String)

      The subnet group name to use for the new cluster.

      Constraints: If provided, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the new cluster belongs to.

    • Tags — (Array<map>)

      The tags to be assigned to the restored cluster.

      • Key — (String)

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • KmsKeyId — (String)

      The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

      If you do not specify a value for the KmsKeyId parameter, then the following occurs:

      • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

      • If the cluster is not encrypted, then the restored cluster is not encrypted.

      If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

    • EnableCloudwatchLogsExports — (Array<String>)

      A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    • DeletionProtection — (Boolean)

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally 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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Service Reference:

Examples:

Calling the startDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
docdb.startDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Service Reference:

Examples:

Calling the stopDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
docdb.stopDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

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:

      • DBCluster — (map)

        Detailed information about a cluster.

        • AvailabilityZones — (Array<String>)

          Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • DBClusterIdentifier — (String)

          Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the cluster parameter group for the cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

          If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master user name for the cluster.

        • PreferredBackupWindow — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source cluster if this cluster is a secondary cluster.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter — (Boolean)

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

        • DbClusterResourceId — (String)

          The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

        • ClusterCreateTime — (Date)

          Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • DeletionProtection — (Boolean)

          Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

  • (AWS.Request) —

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

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

Waits for a given DocDB resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
docdb.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

Waiter Resource Details

docdb.waitFor('dBInstanceAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
docdb.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more instances to describe.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

      • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBInstances — (Array<map>)

        Detailed information about one or more instances.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

See Also:

docdb.waitFor('dBInstanceDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceDeleted state

var params = {
  // ... input parameters ...
};
docdb.waitFor('dBInstanceDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

      Constraints:

      • If provided, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more instances to describe.

      Supported filters:

      • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

      • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

      • Name — required — (String)

        The name of the filter. Filter names are case sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBInstances — (Array<map>)

        Detailed information about one or more instances.

        • DBInstanceIdentifier — (String)

          Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • InstanceCreateTime — (Date)

          Provides the date and time that the instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic snapshots are retained.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone that the instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the subnet group.

          • VpcId — (String)

            Provides the virtual private cloud (VPC) ID of the subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the subnet group.

          • Subnets — (Array<map>)

            Detailed information about one or more subnets within a subnet group.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the Availability Zone for the subnet.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently in-progress change of the master credentials for the instance.

          • Port — (Integer)

            Specifies the pending port for the instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the instance.

            Valid values: license-included, bring-your-own-license, general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new subnet group for the instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

        • PubliclyAccessible — (Boolean)

          Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance is not a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • DBClusterIdentifier — (String)

          Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

        • StorageEncrypted — (Boolean)

          Specifies whether or not the instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

        • DbiResourceId — (String)

          The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • PromotionTier — (Integer)

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the instance.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

See Also: