Class: AWS.DocDB

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.

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.

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 Amazon Web Services 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 Amazon Web Services 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.

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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.

    • If the source snapshot is in a different Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services account, then you must specify a value for KmsKeyId.

    To copy an encrypted cluster snapshot to another Amazon Web Services 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 Amazon Web Services Region that they are created in, and you can't use encryption keys from one Amazon Web Services Region in another Amazon Web Services Region.

    If you copy an unencrypted 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 Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services 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 Amazon Web Services Region.

    The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services 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.

      • StorageType — (String)

        Storage type associated with your cluster snapshot

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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,
  StorageType: 'STRING_VALUE',
  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 Amazon Web Services 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 Amazon Web Services Region, occurring on a random day of the week.

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

    Constraints: Minimum 30-minute window.

  • 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 Amazon Web Services 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 Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services 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.

  • StorageType — (String)

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

    Note: When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

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 Amazon Web Services 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.

      • CloneGroupId — (String)

        Identifies the clone group to which the DB cluster is associated.

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

      • StorageType — (String)

        Storage type associated with your cluster

        Storage type associated with your cluster

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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.

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.

      • StorageType — (String)

        Storage type associated with your cluster snapshot

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBInstanceClass: 'STRING_VALUE', /* required */
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CACertificateIdentifier: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  EnablePerformanceInsights: true || false,
  PerformanceInsightsKMSKeyId: '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 Amazon Web Services 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 Amazon Web Services Region, occurring on a random day of the week.

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

    Constraints: Minimum 30-minute window.

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

  • CopyTagsToSnapshot — (Boolean)

    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

  • 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

  • EnablePerformanceInsights — (Boolean)

    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

  • PerformanceInsightsKMSKeyId — (String)

    The KMS key identifier for encryption of Performance Insights data.

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

  • CACertificateIdentifier — (String)

    The CA certificate identifier to use for the DB instance's server certificate.

    For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

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 Amazon Web Services 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.

      • CopyTagsToSnapshot — (Boolean)

        A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

      • CertificateDetails — (map)

        The details of the DB instance's server certificate.

        • CAIdentifier — (String)

          The CA identifier of the CA certificate used for the DB instance's server certificate.

        • ValidTill — (Date)

          The expiration date of the DB instance’s server certificate.

      • PerformanceInsightsEnabled — (Boolean)

        Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

      • PerformanceInsightsKMSKeyId — (String)

        The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

• (AWS.Request) —

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

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.

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.

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 Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the 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.

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 Amazon Web Services 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.

      • CloneGroupId — (String)

        Identifies the clone group to which the DB cluster is associated.

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

      • StorageType — (String)

        Storage type associated with your cluster

        Storage type associated with your cluster

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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.

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.

      • StorageType — (String)

        Storage type associated with your cluster snapshot

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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.

      • CopyTagsToSnapshot — (Boolean)

        A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

      • CertificateDetails — (map)

        The details of the DB instance's server certificate.

        • CAIdentifier — (String)

          The CA identifier of the CA certificate used for the DB instance's server certificate.

        • ValidTill — (Date)

          The expiration date of the DB instance’s server certificate.

      • PerformanceInsightsEnabled — (Boolean)

        Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

      • PerformanceInsightsKMSKeyId — (String)

        The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

• (AWS.Request) —

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

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.

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.

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 Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the 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.

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 Amazon Web Services 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.

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.

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.

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 Amazon Web Services 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.

      • CloneGroupId — (String)

        Identifies the clone group to which the DB cluster is associated.

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

      • StorageType — (String)

        Storage type associated with your cluster

        Storage type associated with your cluster

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services account to copy or restore.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services account.

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

    • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services 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 Amazon Web Services accounts that this Amazon Web Services 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 Amazon Web Services 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.

      • StorageType — (String)

        Storage type associated with your cluster snapshot

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

Returns:

• (AWS.Request) —

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

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.

      • SupportedCACertificateIdentifiers — (Array<String>)

        A list of the supported CA certificate identifiers.

        For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

      • SupportsCertificateRotationWithoutRestart — (Boolean)

        Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services 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.

      • CopyTagsToSnapshot — (Boolean)

        A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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

      • CertificateDetails — (map)

        The details of the DB instance's server certificate.

        • CAIdentifier — (String)

          The CA identifier of the CA certificate used for the DB instance's server certificate.

        • ValidTill — (Date)

          The expiration date of the DB instance’s server certificate.

      • PerformanceInsightsEnabled — (Boolean)

        Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

      • PerformanceInsightsKMSKeyId — (String)

        The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• dBInstanceAvailable

• dBInstanceDeleted

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.

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.

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.

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.

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.