Class: AWS.RDS

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  FeatureName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE' /* required */
};
rds.addRoleToDBInstance(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 name of the DB instance to associate the IAM role with.

  • RoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

  • FeatureName — (String)

    The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

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 = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
rds.addSourceIdentifierToSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the RDS event notification subscription you want to add a source identifier to.

  • SourceIdentifier — (String)

    The identifier of the event source to be added.

    Constraints:

    • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

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)

      Contains the results of a successful invocation of the DescribeEventSubscriptions action.

      • CustomerAwsId — (String)

        The Amazon Web Services customer account associated with the RDS event notification subscription.

      • CustSubscriptionId — (String)

        The RDS event notification subscription Id.

      • SnsTopicArn — (String)

        The topic ARN of the RDS event notification subscription.

      • Status — (String)

        The status of the RDS event notification subscription.

        Constraints:

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

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

      • SubscriptionCreationTime — (String)

        The time the RDS event notification subscription was created.

      • SourceType — (String)

        The source type for the RDS event notification subscription.

      • SourceIdsList — (Array<String>)

        A list of source IDs for the RDS event notification subscription.

      • EventCategoriesList — (Array<String>)

        A list of event categories for the RDS event notification subscription.

      • Enabled — (Boolean)

        Specifies whether the subscription is enabled. True indicates 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 = {
  ResourceName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.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 RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  • Tags — (Array<map>)

    The tags to be assigned to the Amazon RDS resource.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only 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 */
};
rds.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 RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

  • ApplyAction — (String)

    The pending maintenance action to apply to this resource.

    Valid Values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation

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

      Describes the pending maintenance actions for a resource.

      • ResourceIdentifier — (String)

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

          For more information about maintenance actions, see Maintaining a DB instance.

          Valid Values: system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation

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

        • ForcedApplyDate — (Date)

          The date when the maintenance action is automatically applied.

          On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

        • 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. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

        • 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 = {
  DBSecurityGroupName: 'STRING_VALUE', /* required */
  CIDRIP: 'STRING_VALUE',
  EC2SecurityGroupId: 'STRING_VALUE',
  EC2SecurityGroupName: 'STRING_VALUE',
  EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
rds.authorizeDBSecurityGroupIngress(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: {}) —
  • DBSecurityGroupName — (String)

    The name of the DB security group to add authorization to.

  • CIDRIP — (String)

    The IP range to authorize.

  • EC2SecurityGroupName — (String)

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • EC2SecurityGroupId — (String)

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • EC2SecurityGroupOwnerId — (String)

    Amazon Web Services account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • DBSecurityGroup — (map)

      Contains the details for an Amazon RDS DB security group.

      This data type is used as a response element in the DescribeDBSecurityGroups action.

      • OwnerId — (String)

        Provides the Amazon Web Services ID of the owner of a specific DB security group.

      • DBSecurityGroupName — (String)

        Specifies the name of the DB security group.

      • DBSecurityGroupDescription — (String)

        Provides the description of the DB security group.

      • VpcId — (String)

        Provides the VpcId of the DB security group.

      • EC2SecurityGroups — (Array<map>)

        Contains a list of EC2SecurityGroup elements.

        • Status — (String)

          Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

        • EC2SecurityGroupName — (String)

          Specifies the name of the EC2 security group.

        • EC2SecurityGroupId — (String)

          Specifies the id of the EC2 security group.

        • EC2SecurityGroupOwnerId — (String)

          Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

      • IPRanges — (Array<map>)

        Contains a list of IPRange elements.

        • Status — (String)

          The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

        • CIDRIP — (String)

          The IP range.

      • DBSecurityGroupArn — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  BacktrackTo: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Force: true || false,
  UseEarliestTimeOnPointInTimeUnavailable: true || false
};
rds.backtrackDBCluster(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 DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

  • BacktrackTo — (Date)

    The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

    Note: If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

    Constraints:

    • Must contain a valid ISO 8601 timestamp.

    • Can't contain a timestamp set in the future.

    Example: 2017-07-08T18:00Z

  • Force — (Boolean)

    Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

  • UseEarliestTimeOnPointInTimeUnavailable — (Boolean)

    Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

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:

    • DBClusterIdentifier — (String)

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

    • BacktrackIdentifier — (String)

      Contains the backtrack identifier.

    • BacktrackTo — (Date)

      The timestamp of the time to which the DB cluster was backtracked.

    • BacktrackedFrom — (Date)

      The timestamp of the time from which the DB cluster was backtracked.

    • BacktrackRequestCreationTime — (Date)

      The timestamp of the time at which the backtrack was requested.

    • Status — (String)

      The status of the backtrack. This property returns one of the following values:

      • applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      • pending - The backtrack is currently pending application to or rollback from the DB cluster.

Returns:

• (AWS.Request) —

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

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

    The identifier of the snapshot or cluster export task to cancel.

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:

    • ExportTaskIdentifier — (String)

      A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

    • SourceArn — (String)

      The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    • ExportOnly — (Array<String>)

      The data exported from the snapshot or cluster.

      Valid Values:

      • database - Export all the data from a specified database.

      • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    • SnapshotTime — (Date)

      The time when the snapshot was created.

    • TaskStartTime — (Date)

      The time when the snapshot or cluster export task started.

    • TaskEndTime — (Date)

      The time when the snapshot or cluster export task ended.

    • S3Bucket — (String)

      The Amazon S3 bucket where the snapshot or cluster is exported to.

    • S3Prefix — (String)

      The Amazon S3 bucket prefix that is the file name and path of the exported data.

    • IamRoleArn — (String)

      The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

    • KmsKeyId — (String)

      The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

    • Status — (String)

      The progress status of the export task. The status can be one of the following:

      • CANCELED

      • CANCELING

      • COMPLETE

      • FAILED

      • IN_PROGRESS

      • STARTING

    • PercentProgress — (Integer)

      The progress of the snapshot or cluster export task as a percentage.

    • TotalExtractedDataInGB — (Integer)

      The total amount of data exported, in gigabytes.

    • FailureCause — (String)

      The reason the export failed, if it failed.

    • WarningMessage — (String)

      A warning about the snapshot or cluster export task.

    • SourceType — (String)

      The type of source for the export.

      Possible values include:
      • "SNAPSHOT"
      • "CLUSTER"

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 */
  ]
};
rds.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 DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

    Constraints:

    • Must specify a valid DB cluster parameter group.

  • TargetDBClusterParameterGroupIdentifier — (String)

    The identifier for the copied DB cluster parameter group.

    Constraints:

    • Can't be null, empty, or blank

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

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster-param-group1

  • TargetDBClusterParameterGroupDescription — (String)

    A description for the copied DB cluster parameter group.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only 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)

      Contains the details of an Amazon RDS DB cluster parameter group.

      This data type is used as a response element in the DescribeDBClusterParameterGroups action.

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

      • DBParameterGroupFamily — (String)

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

      • Description — (String)

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

      • DBClusterParameterGroupArn — (String)

        The Amazon Resource Name (ARN) for the DB 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',
  SourceRegion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.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 DB cluster snapshot to copy. This parameter isn't case-sensitive.

    You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

    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 DB snapshot identifier.

    • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    Example: my-cluster-snapshot1

  • TargetDBClusterSnapshotIdentifier — (String)

    The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

    Constraints:

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

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot2

  • KmsKeyId — (String)

    The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

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

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

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

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

  • PreSignedUrl — (String)

    When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

    This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

    The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

    • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB 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 DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

    Note: 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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
    Note: If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
  • CopyTags — (Boolean)

    Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

  • SourceRegion — (String)

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

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)

      Contains the details for an Amazon RDS DB cluster snapshot

      This data type is used as a response element in the DescribeDBClusterSnapshots action.

      • AvailabilityZones — (Array<String>)

        The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

      • DBClusterSnapshotIdentifier — (String)

        The identifier for the DB cluster snapshot.

      • DBClusterIdentifier — (String)

        The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

      • SnapshotCreateTime — (Date)

        The time when the snapshot was taken, in Universal Coordinated Time (UTC).

      • Engine — (String)

        The name of the database engine for this DB cluster snapshot.

      • EngineMode — (String)

        The engine mode of the database engine for this DB cluster snapshot.

      • AllocatedStorage — (Integer)

        The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

      • Status — (String)

        The status of this DB cluster snapshot. Valid statuses are the following:

        • available

        • copying

        • creating

      • Port — (Integer)

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

      • VpcId — (String)

        The VPC ID associated with the DB cluster snapshot.

      • ClusterCreateTime — (Date)

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

      • MasterUsername — (String)

        The master username for this DB cluster snapshot.

      • EngineVersion — (String)

        The version of the database engine for this DB cluster snapshot.

      • LicenseModel — (String)

        The license model information for this DB cluster snapshot.

      • SnapshotType — (String)

        The type of the DB cluster snapshot.

      • PercentProgress — (Integer)

        The percentage of the estimated data that has been transferred.

      • StorageEncrypted — (Boolean)

        Indicates whether the DB cluster snapshot is encrypted.

      • KmsKeyId — (String)

        If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

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

      • DBClusterSnapshotArn — (String)

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

      • SourceDBClusterSnapshotArn — (String)

        If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • TagList — (Array<map>)

        A list of tags.

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

        • Key — (String)

          A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

        • Value — (String)

          A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

      • DBSystemId — (String)

        Reserved for future use.

      • StorageType — (String)

        The storage type associated with the DB cluster snapshot.

        This setting is only for Aurora DB clusters.

      • DbClusterResourceId — (String)

        The resource ID of the DB cluster that this DB cluster snapshot was created from.

      • StorageThroughput — (Integer)

        The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

        This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

• (AWS.Request) —

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

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

    The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    Constraints:

    • Must specify a valid DB parameter group.

  • TargetDBParameterGroupIdentifier — (String)

    The identifier for the copied DB parameter group.

    Constraints:

    • Can't be null, empty, or blank

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

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-db-parameter-group

  • TargetDBParameterGroupDescription — (String)

    A description for the copied DB parameter group.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only 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:

    • DBParameterGroup — (map)

      Contains the details of an Amazon RDS DB parameter group.

      This data type is used as a response element in the DescribeDBParameterGroups action.

      • DBParameterGroupName — (String)

        The name of the DB parameter group.

      • DBParameterGroupFamily — (String)

        The name of the DB parameter group family that this DB parameter group is compatible with.

      • Description — (String)

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

      • DBParameterGroupArn — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  SourceDBSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetDBSnapshotIdentifier: 'STRING_VALUE', /* required */
  CopyOptionGroup: true || false,
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  SourceRegion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetCustomAvailabilityZone: 'STRING_VALUE'
};
rds.copyDBSnapshot(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: {}) —
  • SourceDBSnapshotIdentifier — (String)

    The identifier for the source DB snapshot.

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

    If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

    If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

    If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

    Constraints:

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

    Example: rds:mydb-2012-04-02-00-01

    Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

  • TargetDBSnapshotIdentifier — (String)

    The identifier for the copy of the snapshot.

    Constraints:

    • Can't be null, empty, or blank

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

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-db-snapshot

  • KmsKeyId — (String)

    The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

    If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.

    If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

    If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

  • CopyTags — (Boolean)

    Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.

  • PreSignedUrl — (String)

    When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

    This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

    You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

    The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL.

      For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

    • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

    • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted 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 DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

    Note: 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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
    Note: If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
  • OptionGroupName — (String)

    The name of an option group to associate with the copy of the snapshot.

    Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

  • TargetCustomAvailabilityZone — (String)

    The external custom Availability Zone (CAZ) identifier for the target CAZ.

    Example: rds-caz-aiqhTgQv.

  • CopyOptionGroup — (Boolean)

    Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.

  • SourceRegion — (String)

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

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:

    • DBSnapshot — (map)

      Contains the details of an Amazon RDS DB snapshot.

      This data type is used as a response element in the DescribeDBSnapshots action.

      • DBSnapshotIdentifier — (String)

        Specifies the identifier for the DB snapshot.

      • DBInstanceIdentifier — (String)

        Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

      • SnapshotCreateTime — (Date)

        Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

      • Engine — (String)

        Specifies the name of the database engine.

      • AllocatedStorage — (Integer)

        Specifies the allocated storage size in gibibytes (GiB).

      • Status — (String)

        Specifies the status of this DB snapshot.

      • Port — (Integer)

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

      • AvailabilityZone — (String)

        Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

      • VpcId — (String)

        Provides the VPC ID associated with the DB snapshot.

      • InstanceCreateTime — (Date)

        Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

      • MasterUsername — (String)

        Provides the master username for the DB snapshot.

      • EngineVersion — (String)

        Specifies the version of the database engine.

      • LicenseModel — (String)

        License model information for the restored DB instance.

      • SnapshotType — (String)

        Provides the type of the DB snapshot.

      • Iops — (Integer)

        Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

      • OptionGroupName — (String)

        Provides the option group name for the DB snapshot.

      • PercentProgress — (Integer)

        The percentage of the estimated data that has been transferred.

      • SourceRegion — (String)

        The Amazon Web Services Region that the DB snapshot was created in or copied from.

      • SourceDBSnapshotIdentifier — (String)

        The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

      • StorageType — (String)

        Specifies the storage type associated with DB snapshot.

      • TdeCredentialArn — (String)

        The ARN from the key store with which to associate the instance for TDE encryption.

      • Encrypted — (Boolean)

        Indicates whether the DB snapshot is encrypted.

      • KmsKeyId — (String)

        If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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

      • DBSnapshotArn — (String)

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

      • Timezone — (String)

        The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • ProcessorFeatures — (Array<map>)

        The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

        • Name — (String)

          The name of the processor feature. Valid names are coreCount and threadsPerCore.

        • Value — (String)

          The value of a processor feature.

      • DbiResourceId — (String)

        The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

      • TagList — (Array<map>)

        A list of tags.

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

        • Key — (String)

          A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

        • Value — (String)

          A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

      • OriginalSnapshotCreateTime — (Date)

        Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

      • SnapshotDatabaseTime — (Date)

        The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

        If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

      • SnapshotTarget — (String)

        Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

      • StorageThroughput — (Integer)

        Specifies the storage throughput for the DB snapshot.

      • DBSystemId — (String)

        The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

      • DedicatedLogVolume — (Boolean)

        Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

      • MultiTenant — (Boolean)

        Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Returns:

• (AWS.Request) —

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

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

    The identifier for the source option group.

    Constraints:

    • Must specify a valid option group.

  • TargetOptionGroupIdentifier — (String)

    The identifier for the copied option group.

    Constraints:

    • Can't be null, empty, or blank

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

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

  • TargetOptionGroupDescription — (String)

    The description for the copied option group.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only 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:

    • OptionGroup — (map)
      • OptionGroupName — (String)

        Specifies the name of the option group.

      • OptionGroupDescription — (String)

        Provides a description of the option group.

      • EngineName — (String)

        Indicates the name of the engine that this option group can be applied to.

      • MajorEngineVersion — (String)

        Indicates the major engine version associated with this option group.

      • Options — (Array<map>)

        Indicates what options are available in the option group.

        • OptionName — (String)

          The name of the option.

        • OptionDescription — (String)

          The description of the option.

        • Persistent — (Boolean)

          Indicates whether this option is persistent.

        • Permanent — (Boolean)

          Indicates whether this option is permanent.

        • Port — (Integer)

          If required, the port configured for this option to use.

        • OptionVersion — (String)

          The version of the option.

        • OptionSettings — (Array<map>)

          The option settings for this option.

          • Name — (String)

            The name of the option that has settings that you can set.

          • Value — (String)

            The current value of the option setting.

          • DefaultValue — (String)

            The default value of the option setting.

          • Description — (String)

            The description of the option setting.

          • ApplyType — (String)

            The DB engine specific parameter type.

          • DataType — (String)

            The data type of the option setting.

          • AllowedValues — (String)

            The allowed values of the option setting.

          • IsModifiable — (Boolean)

            Indicates whether the option setting can be modified from the default.

          • IsCollection — (Boolean)

            Indicates whether the option setting is part of a collection.

        • DBSecurityGroupMemberships — (Array<map>)

          If the option requires access to a port, then this DB security group allows access to the port.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroupMemberships — (Array<map>)

          If the option requires access to a port, then this VPC security group allows access to the port.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The membership status of the VPC security group.

            Currently, the only valid status is active.

      • AllowsVpcAndNonVpcInstanceMemberships — (Boolean)

        Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

      • VpcId — (String)

        If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

      • OptionGroupArn — (String)

        Specifies the Amazon Resource Name (ARN) for the option group.

      • SourceOptionGroup — (String)

        Specifies the name of the option group from which this option group is copied.

      • SourceAccountId — (String)

        Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

      • CopyTimestamp — (Date)

        Indicates when the option group was copied.

Returns:

• (AWS.Request) —

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

var params = {
  BlueGreenDeploymentName: 'STRING_VALUE', /* required */
  Source: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetDBClusterParameterGroupName: 'STRING_VALUE',
  TargetDBInstanceClass: 'STRING_VALUE',
  TargetDBParameterGroupName: 'STRING_VALUE',
  TargetEngineVersion: 'STRING_VALUE',
  UpgradeTargetStorageConfig: true || false
};
rds.createBlueGreenDeployment(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: {}) —
  • BlueGreenDeploymentName — (String)

    The name of the blue/green deployment.

    Constraints:

    • Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

  • Source — (String)

    The Amazon Resource Name (ARN) of the source production database.

    Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

  • TargetEngineVersion — (String)

    The engine version of the database in the green environment.

    Specify the engine version to upgrade to in the green environment.

  • TargetDBParameterGroupName — (String)

    The DB parameter group associated with the DB instance in the green environment.

    To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

  • TargetDBClusterParameterGroupName — (String)

    The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

    To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

  • Tags — (Array<map>)

    Tags to assign to the blue/green deployment.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

  • TargetDBInstanceClass — (String)

    Specify the DB instance class for the databases in the green environment.

    This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.

  • UpgradeTargetStorageConfig — (Boolean)

    Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB 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:

    • BlueGreenDeployment — (map)

      Details about a blue/green deployment.

      For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

      • BlueGreenDeploymentIdentifier — (String)

        The unique identifier of the blue/green deployment.

      • BlueGreenDeploymentName — (String)

        The user-supplied name of the blue/green deployment.

      • Source — (String)

        The source database for the blue/green deployment.

        Before switchover, the source database is the production database in the blue environment.

      • Target — (String)

        The target database for the blue/green deployment.

        Before switchover, the target database is the clone database in the green environment.

      • SwitchoverDetails — (Array<map>)

        The details about each source and target resource in the blue/green deployment.

        • SourceMember — (String)

          The Amazon Resource Name (ARN) of a resource in the blue environment.

        • TargetMember — (String)

          The Amazon Resource Name (ARN) of a resource in the green environment.

        • Status — (String)

          The switchover status of a resource in a blue/green deployment.

          Values:

          • PROVISIONING - The resource is being prepared to switch over.

          • AVAILABLE - The resource is ready to switch over.

          • SWITCHOVER_IN_PROGRESS - The resource is being switched over.

          • SWITCHOVER_COMPLETED - The resource has been switched over.

          • SWITCHOVER_FAILED - The resource attempted to switch over but failed.

          • MISSING_SOURCE - The source resource has been deleted.

          • MISSING_TARGET - The target resource has been deleted.

      • Tasks — (Array<map>)

        Either tasks to be performed or tasks that have been completed on the target database before switchover.

        • Name — (String)

          The name of the blue/green deployment task.

        • Status — (String)

          The status of the blue/green deployment task.

          Valid Values:

          • PENDING - The resource is being prepared for deployment.

          • IN_PROGRESS - The resource is being deployed.

          • COMPLETED - The resource has been deployed.

          • FAILED - Deployment of the resource failed.

      • Status — (String)

        The status of the blue/green deployment.

        Valid Values:

        • PROVISIONING - Resources are being created in the green environment.

        • AVAILABLE - Resources are available in the green environment.

        • SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.

        • SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

        • INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

        • SWITCHOVER_FAILED - Switchover was attempted but failed.

        • DELETING - The blue/green deployment is being deleted.

      • StatusDetails — (String)

        Additional information about the status of the blue/green deployment.

      • CreateTime — (Date)

        The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

      • DeleteTime — (Date)

        The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

      • TagList — (Array<map>)

        A list of tags.

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

        • Key — (String)

          A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

        • Value — (String)

          A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

Returns:

• (AWS.Request) —

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

var params = {
  Engine: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  DatabaseInstallationFilesS3BucketName: 'STRING_VALUE',
  DatabaseInstallationFilesS3Prefix: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ImageId: 'STRING_VALUE',
  KMSKeyId: 'STRING_VALUE',
  Manifest: 'STRING_VALUE',
  SourceCustomDbEngineVersionIdentifier: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseAwsProvidedLatestImage: true || false
};
rds.createCustomDBEngineVersion(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. RDS Custom for Oracle supports the following values:

    • custom-oracle-ee

    • custom-oracle-ee-cdb

    • custom-oracle-se2

    • custom-oracle-se2-cdb

  • EngineVersion — (String)

    The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.

  • DatabaseInstallationFilesS3BucketName — (String)

    The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.

  • DatabaseInstallationFilesS3Prefix — (String)

    The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

  • ImageId — (String)

    The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.

  • KMSKeyId — (String)

    The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.

    If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.

    You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

  • Description — (String)

    An optional description of your CEV.

  • Manifest — (String)

    The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.

    The following JSON fields are valid:

    MediaImportTemplateVersion

    Version of the CEV manifest. The date is in the format YYYY-MM-DD.

    databaseInstallationFileNames

    Ordered list of installation files for the CEV.

    opatchFileNames

    Ordered list of OPatch installers used for the Oracle DB engine.

    psuRuPatchFileNames

    The PSU and RU patches for this CEV.

    OtherPatchFileNames

    The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.

    For more information, see Creating the CEV manifest in the Amazon RDS User Guide.

  • Tags — (Array<map>)

    A list of tags.

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

  • SourceCustomDbEngineVersionIdentifier — (String)

    The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.

  • UseAwsProvidedLatestImage — (Boolean)

    Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.

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:

    • Engine — (String)

      The name of the database engine.

    • EngineVersion — (String)

      The version number of the database engine.

    • DBParameterGroupFamily — (String)

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

    • DBEngineDescription — (String)

      The description of the database engine.

    • DBEngineVersionDescription — (String)

      The description of the database engine version.

    • DefaultCharacterSet — (map)

      The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

      • CharacterSetName — (String)

        The name of the character set.

      • CharacterSetDescription — (String)

        The description of the character set.

    • Image — (map)

      The EC2 image

      • ImageId — (String)

        A value that indicates the ID of the AMI.

      • Status — (String)

        A value that indicates the status of a custom engine version (CEV).

    • DBEngineMediaType — (String)

      A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

    • SupportedCharacterSets — (Array<map>)

      A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

      • CharacterSetName — (String)

        The name of the character set.

      • CharacterSetDescription — (String)

        The description of the character set.

    • SupportedNcharCharacterSets — (Array<map>)

      A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

      • CharacterSetName — (String)

        The name of the character set.

      • CharacterSetDescription — (String)

        The description of the character set.

    • 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 a DB instance can be upgraded to.

      • AutoUpgrade — (Boolean)

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

        This parameter is dynamic, and is set by RDS.

      • IsMajorVersionUpgrade — (Boolean)

        Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

      • SupportedEngineModes — (Array<String>)

        A list of the supported DB engine modes for the target engine version.

      • SupportsParallelQuery — (Boolean)

        Indicates whether you can use Aurora parallel query with the target engine version.

      • SupportsGlobalDatabases — (Boolean)

        Indicates whether you can use Aurora global databases with the target engine version.

      • SupportsBabelfish — (Boolean)

        Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

      • SupportsLimitlessDatabase — (Boolean)

        Indicates whether the DB engine version supports Aurora Limitless Database.

      • SupportsLocalWriteForwarding — (Boolean)

        Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

        Valid for: Aurora DB clusters only

      • SupportsIntegrations — (Boolean)

        Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

    • SupportedTimezones — (Array<map>)

      A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

      • TimezoneName — (String)

        The name of the time zone.

    • ExportableLogTypes — (Array<String>)

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

    • SupportsLogExportsToCloudwatchLogs — (Boolean)

      Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

    • SupportsReadReplica — (Boolean)

      Indicates whether the database engine version supports read replicas.

    • SupportedEngineModes — (Array<String>)

      A list of the supported DB engine modes.

    • SupportedFeatureNames — (Array<String>)

      A list of features supported by the DB engine.

      The supported features vary by DB engine and DB engine version.

      To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

      aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

      For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

      aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

      The supported features are listed under SupportedFeatureNames in the output.

    • Status — (String)

      The status of the DB engine version, either available or deprecated.

    • SupportsParallelQuery — (Boolean)

      Indicates whether you can use Aurora parallel query with a specific DB engine version.

    • SupportsGlobalDatabases — (Boolean)

      Indicates whether you can use Aurora global databases with a specific DB engine version.

    • MajorEngineVersion — (String)

      The major engine version of the CEV.

    • DatabaseInstallationFilesS3BucketName — (String)

      The name of the Amazon S3 bucket that contains your database installation files.

    • DatabaseInstallationFilesS3Prefix — (String)

      The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

    • DBEngineVersionArn — (String)

      The ARN of the custom engine version.

    • KMSKeyId — (String)

      The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

    • CreateTime — (Date)

      The creation time of the DB engine version.

    • TagList — (Array<map>)

      A list of tags.

      For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

      • Key — (String)

        A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

      • Value — (String)

        A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • SupportsBabelfish — (Boolean)

      Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

    • CustomDBEngineVersionManifest — (String)

      JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

    • SupportsLimitlessDatabase — (Boolean)

      Indicates whether the DB engine version supports Aurora Limitless Database.

    • SupportsCertificateRotationWithoutRestart — (Boolean)

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

    • SupportedCACertificateIdentifiers — (Array<String>)

      A list of the supported CA certificate identifiers.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

    • SupportsLocalWriteForwarding — (Boolean)

      Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

      Valid for: Aurora DB clusters only

    • SupportsIntegrations — (Boolean)

      Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

Returns:

• (AWS.Request) —

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

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BacktrackWindow: 'NUMBER_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CACertificateIdentifier: 'STRING_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterInstanceClass: 'STRING_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DBSystemId: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableGlobalWriteForwarding: true || false,
  EnableHttpEndpoint: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  EnableLimitlessDatabase: true || false,
  EnableLocalWriteForwarding: true || false,
  EnablePerformanceInsights: true || false,
  EngineLifecycleSupport: 'STRING_VALUE',
  EngineMode: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  ManageMasterUserPassword: true || false,
  MasterUserPassword: 'STRING_VALUE',
  MasterUserSecretKmsKeyId: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  NetworkType: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  PerformanceInsightsRetentionPeriod: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PubliclyAccessible: true || false,
  RdsCustomClusterConfiguration: {
    InterconnectSubnetId: 'STRING_VALUE',
    ReplicaMode: open-read-only | mounted,
    TransitGatewayMulticastDomainId: 'STRING_VALUE'
  },
  ReplicationSourceIdentifier: 'STRING_VALUE',
  ScalingConfiguration: {
    AutoPause: true || false,
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE',
    SecondsBeforeTimeout: 'NUMBER_VALUE',
    SecondsUntilAutoPause: 'NUMBER_VALUE',
    TimeoutAction: 'STRING_VALUE'
  },
  ServerlessV2ScalingConfiguration: {
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE'
  },
  SourceRegion: 'STRING_VALUE',
  StorageEncrypted: true || false,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.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 Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

    For information on AZs, see Availability Zones in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

    Constraints:

    • Can't specify more than three AZs.

  • BackupRetentionPeriod — (Integer)

    The number of days for which automated backups are retained.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Default: 1

    Constraints:

    • Must be a value from 1 to 35.

  • CharacterSetName — (String)

    The name of the character set (CharacterSet) to associate the DB cluster with.

    Valid for Cluster Type: Aurora DB clusters only

  • DatabaseName — (String)

    The name for your database of up to 64 alphanumeric characters. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • DBClusterIdentifier — (String)

    The identifier for this DB cluster. This parameter is stored as a lowercase string.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

  • DBClusterParameterGroupName — (String)

    The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.

  • VpcSecurityGroupIds — (Array<String>)

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

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • DBSubnetGroupName — (String)

    A DB subnet group to associate with this DB cluster.

    This setting is required to create a Multi-AZ DB cluster.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • Must match the name of an existing DB subnet group.

    Example: mydbsubnetgroup

  • Engine — (String)

    The database engine to use for this DB cluster.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Valid Values:

    • aurora-mysql

    • aurora-postgresql

    • mysql

    • postgres

    • neptune - For information about using Amazon Neptune, see the Amazon Neptune User Guide .

  • EngineVersion — (String)

    The version number of the database engine to use.

    To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

    You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

    To list all of the available engine versions for Aurora PostgreSQL, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for RDS for MySQL, use the following command:

    aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

    To list all of the available engine versions for RDS for PostgreSQL, use the following command:

    aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

    For information about a specific engine, see the following topics:

    • Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

    • Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

    • RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.

    • RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • Port — (Integer)

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

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Valid Values: 1150-65535

    Default:

    • RDS for MySQL and Aurora MySQL - 3306

    • RDS for PostgreSQL and Aurora PostgreSQL - 5432

  • MasterUsername — (String)

    The name of the master user for the DB cluster.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

  • MasterUserPassword — (String)

    The password for the master database user.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • Must contain from 8 to 41 characters.

    • Can contain any printable ASCII character except "/", """, or "@".

    • Can't be specified if ManageMasterUserPassword is turned on.

  • OptionGroupName — (String)

    The option group to associate the DB cluster with.

    DB clusters are associated with a default option group that can't be modified.

  • PreferredBackupWindow — (String)

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

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

    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.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

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

    • Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    • Must be in Universal Coordinated Time (UTC).

    • Must be at least 30 minutes.

  • ReplicationSourceIdentifier — (String)

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • Tags — (Array<map>)

    Tags to assign to the DB cluster.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    • Key — (String)

      A key is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

    • Value — (String)

      A value is 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 only contain only the set of Unicode letters, digits, white-space, '', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-@]*)$").

  • StorageEncrypted — (Boolean)

    Specifies whether the DB cluster is encrypted.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • KmsKeyId — (String)

    The Amazon Web Services KMS key identifier for an encrypted DB cluster.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

    When a KMS key isn't specified in KmsKeyId:

    • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.

    • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS 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.

    If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • PreSignedUrl — (String)

    When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

    The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

    The presigned URL request must contain the following parameter values:

    • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

    • DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.

    • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster 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 DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

    Note: 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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

    Valid for Cluster Type: Aurora DB clusters only

    Note: If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
  • EnableIAMDatabaseAuthentication — (Boolean)

    Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

  • BacktrackWindow — (Integer)

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Valid for Cluster Type: Aurora MySQL DB clusters only

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

  • EnableCloudwatchLogsExports — (Array<String>)

    The list of log types that need to be enabled for exporting to CloudWatch Logs.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    The following values are valid for each DB engine:

    • Aurora MySQL - audit | error | general | slowquery

    • Aurora PostgreSQL - postgresql

    • RDS for MySQL - error | general | slowquery

    • RDS for PostgreSQL - postgresql | upgrade

    For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

  • EngineMode — (String)

    The DB engine mode of the DB cluster, either provisioned or serverless.

    The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.

    For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:

    • Limitations of Aurora Serverless v1

    • Requirements for Aurora Serverless v2

    Valid for Cluster Type: Aurora DB clusters only

  • ScalingConfiguration — (map)

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    Valid for Cluster Type: Aurora DB clusters only

    • MinCapacity — (Integer)

      The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

      For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

      For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

      The minimum capacity must be less than or equal to the maximum capacity.

    • MaxCapacity — (Integer)

      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

      For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

      For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

      The maximum capacity must be greater than or equal to the minimum capacity.

    • AutoPause — (Boolean)

      Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

      Note: If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
    • SecondsUntilAutoPause — (Integer)

      The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

      Specify a value between 300 and 86,400 seconds.

    • TimeoutAction — (String)

      The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

      ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

      RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

      If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

      For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

    • SecondsBeforeTimeout — (Integer)

      The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

      Specify a value between 60 and 600 seconds.

  • RdsCustomClusterConfiguration — (map)

    Reserved for future use.

    • InterconnectSubnetId — (String)

      Reserved for future use.

    • TransitGatewayMulticastDomainId — (String)

      Reserved for future use.

    • ReplicaMode — (String)

      Reserved for future use.

      Possible values include:
      • "open-read-only"
      • "mounted"
  • DeletionProtection — (Boolean)

    Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • GlobalClusterIdentifier — (String)

    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

    Valid for Cluster Type: Aurora DB clusters only

  • EnableHttpEndpoint — (Boolean)

    Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

    RDS Data API is supported with the following DB clusters:

    • Aurora PostgreSQL Serverless v2 and provisioned

    • Aurora PostgreSQL and Aurora MySQL Serverless v1

    For more information, see Using RDS Data API in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

  • CopyTagsToSnapshot — (Boolean)

    Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • Domain — (String)

    The Active Directory directory ID to create the DB cluster in.

    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

    For more information, see Kerberos authentication in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

  • DomainIAMRoleName — (String)

    The name of the IAM role to use when making API calls to the Directory Service.

    Valid for Cluster Type: Aurora DB clusters only

  • EnableGlobalWriteForwarding — (Boolean)

    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

    You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

    Valid for Cluster Type: Aurora DB clusters only

  • DBClusterInstanceClass — (String)

    The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

    For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

    This setting is required to create a Multi-AZ DB cluster.

    Valid for Cluster Type: Multi-AZ DB clusters only

  • AllocatedStorage — (Integer)

    The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

    Valid for Cluster Type: Multi-AZ DB clusters only

    This setting is required to create a Multi-AZ DB cluster.

  • StorageType — (String)

    The storage type to associate with the DB cluster.

    For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.

    This setting is required to create a Multi-AZ DB cluster.

    When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Valid Values:

    • Aurora DB clusters - aurora | aurora-iopt1

    • Multi-AZ DB clusters - io1 | io2 | gp3

    Default:

    • Aurora DB clusters - aurora

    • Multi-AZ DB clusters - io1

    Note: When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to aurora.
  • Iops — (Integer)

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

    For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.

    This setting is required to create a Multi-AZ DB cluster.

    Valid for Cluster Type: Multi-AZ DB clusters only

    Constraints:

    • Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

  • PubliclyAccessible — (Boolean)

    Specifies whether the DB cluster is publicly accessible.

    When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

    When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

    Valid for Cluster Type: Multi-AZ DB clusters only

    Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

    If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

    • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

    • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

  • AutoMinorVersionUpgrade — (Boolean)

    Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

    Valid for Cluster Type: Multi-AZ DB clusters only

  • MonitoringInterval — (Integer)

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

    If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

    Valid for Cluster Type: Multi-AZ DB clusters only

    Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

    Default: 0

  • MonitoringRoleArn — (String)

    The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

    If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

    Valid for Cluster Type: Multi-AZ DB clusters only

  • EnablePerformanceInsights — (Boolean)

    Specifies whether to turn on Performance Insights for the DB cluster.

    For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

    Valid for Cluster Type: Multi-AZ DB clusters only

  • PerformanceInsightsKMSKeyId — (String)

    The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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

    If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.

    Valid for Cluster Type: Multi-AZ DB clusters only

  • PerformanceInsightsRetentionPeriod — (Integer)

    The number of days to retain Performance Insights data.

    Valid for Cluster Type: Multi-AZ DB clusters only

    Valid Values:

    • 7

    • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    • 731

    Default: 7 days

    If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

  • EnableLimitlessDatabase — (Boolean)

    Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

    Valid for: Aurora DB clusters only

  • ServerlessV2ScalingConfiguration — (map)

    Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

    For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

    • MinCapacity — (Float)

      The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

    • MaxCapacity — (Float)

      The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.

  • NetworkType — (String)

    The network type of the DB cluster.

    The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters only

    Valid Values: IPV4 | DUAL

  • DBSystemId — (String)

    Reserved for future use.

  • ManageMasterUserPassword — (Boolean)

    Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

    For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Constraints:

    • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

  • MasterUserSecretKmsKeyId — (String)

    The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

    This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

    If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed 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.

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

  • EnableLocalWriteForwarding — (Boolean)

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    Valid for: Aurora DB clusters only

  • CACertificateIdentifier — (String)

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

    For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.

    Valid for Cluster Type: Multi-AZ DB clusters

  • EngineLifecycleSupport — (String)

    The life cycle type for this DB cluster.

    Note: By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.

    You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

    • Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide

    • Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

    Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

    Default: open-source-rds-extended-support

  • SourceRegion — (String)

    The ID of the region that contains the source for the read replica.

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)

      Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

      For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

      For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

      For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

      For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

      • AllocatedStorage — (Integer)

        For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • AvailabilityZones — (Array<String>)

        The list of Availability Zones (AZs) where instances in the DB cluster can be created.

      • BackupRetentionPeriod — (Integer)

        The number of days for which automatic DB snapshots are retained.

      • CharacterSetName — (String)

        If present, specifies the name of the character set that this cluster is associated with.

      • DatabaseName — (String)

        The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

      • DBClusterIdentifier — (String)

        The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

      • DBClusterParameterGroup — (String)

        The name of the DB cluster parameter group for the DB cluster.

      • DBSubnetGroup — (String)

        Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

      • Status — (String)

        The current state of this DB cluster.

      • AutomaticRestartTime — (Date)

        The time when a stopped DB cluster is restarted automatically.

      • PercentProgress — (String)

        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)

        The connection endpoint for the primary instance of the DB cluster.

      • ReaderEndpoint — (String)

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

        If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

      • CustomEndpoints — (Array<String>)

        The custom endpoints associated with the DB cluster.

      • MultiAZ — (Boolean)

        Indicates whether the DB cluster has instances in multiple Availability Zones.

      • Engine — (String)

        The database engine used for this DB cluster.

      • EngineVersion — (String)

        The version of the database engine.

      • LatestRestorableTime — (Date)

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

      • Port — (Integer)

        The port that the database engine is listening on.

      • MasterUsername — (String)

        The master username for the DB cluster.

      • DBClusterOptionGroupMemberships — (Array<map>)

        The list of option group memberships for this DB cluster.

        • DBClusterOptionGroupName — (String)

          Specifies the name of the DB cluster option group.

        • Status — (String)

          Specifies the status of the DB cluster option group.

      • PreferredBackupWindow — (String)

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

      • PreferredMaintenanceWindow — (String)

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

      • ReplicationSourceIdentifier — (String)

        The identifier of the source DB cluster if this DB cluster is a read replica.

      • ReadReplicaIdentifiers — (Array<String>)

        Contains one or more identifiers of the read replicas associated with this DB cluster.

      • StatusInfos — (Array<map>)

        Reserved for future use.

        • StatusType — (String)

          Reserved for future use.

        • Normal — (Boolean)

          Reserved for future use.

        • Status — (String)

          Reserved for future use.

        • Message — (String)

          Reserved for future use.

      • DBClusterMembers — (Array<map>)

        The list of DB instances that make up the DB cluster.

        • DBInstanceIdentifier — (String)

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter — (Boolean)

          Indicates whether the cluster member is the primary DB instance for the DB cluster.

        • DBClusterParameterGroupStatus — (String)

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

        • PromotionTier — (Integer)

          A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

      • VpcSecurityGroups — (Array<map>)

        The list of VPC security groups that the DB cluster belongs to.

        • VpcSecurityGroupId — (String)

          The name of the VPC security group.

        • Status — (String)

          The membership status of the VPC security group.

          Currently, the only valid status is active.

      • HostedZoneId — (String)

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

      • StorageEncrypted — (Boolean)

        Indicates whether the DB cluster is encrypted.

      • KmsKeyId — (String)

        If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

      • DbClusterResourceId — (String)

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

      • DBClusterArn — (String)

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

      • AssociatedRoles — (Array<map>)

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

        • RoleArn — (String)

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

        • Status — (String)

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.

        • FeatureName — (String)

          The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • CloneGroupId — (String)

        The ID of the clone group with which the DB cluster is associated.

      • ClusterCreateTime — (Date)

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

      • EarliestBacktrackTime — (Date)

        The earliest time to which a DB cluster can be backtracked.

      • BacktrackWindow — (Integer)

        The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

      • BacktrackConsumedChangeRecords — (Integer)

        The number of change records stored for Backtrack.

      • EnabledCloudwatchLogsExports — (Array<String>)

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

        Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

      • Capacity — (Integer)

        The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

        For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

      • EngineMode — (String)

        The DB engine mode of the DB cluster, either provisioned or serverless.

        For more information, see CreateDBCluster.

      • ScalingConfigurationInfo — (map)

        The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

        For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

        • MinCapacity — (Integer)

          The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

        • MaxCapacity — (Integer)

          The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

        • AutoPause — (Boolean)

          Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

          When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

        • SecondsUntilAutoPause — (Integer)

          The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

        • TimeoutAction — (String)

          The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.

          ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

          RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

        • SecondsBeforeTimeout — (Integer)

          The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.

      • RdsCustomClusterConfiguration — (map)

        Reserved for future use.

        • InterconnectSubnetId — (String)

          Reserved for future use.

        • TransitGatewayMulticastDomainId — (String)

          Reserved for future use.

        • ReplicaMode — (String)

          Reserved for future use.

          Possible values include:
          • "open-read-only"
          • "mounted"
      • DeletionProtection — (Boolean)

        Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • HttpEndpointEnabled — (Boolean)

        Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

        When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

        For more information, see Using RDS Data API in the Amazon Aurora User Guide.

      • ActivityStreamMode — (String)

        The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

        Possible values include:
        • "sync"
        • "async"
      • ActivityStreamStatus — (String)

        The status of the database activity stream.

        Possible values include:
        • "stopped"
        • "starting"
        • "started"
        • "stopping"
      • ActivityStreamKmsKeyId — (String)

        The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

      • ActivityStreamKinesisStreamName — (String)

        The name of the Amazon Kinesis data stream used for the database activity stream.

      • CopyTagsToSnapshot — (Boolean)

        Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

      • CrossAccountClone — (Boolean)