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

Class: AWS.RDS

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

Overview

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

Service Description

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

Sending a Request Using RDS

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

Locking the API Version

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

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

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

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

var rds = new AWS.RDS();

Version:

  • 2014-10-31

Defined Under Namespace

Classes: Signer

Waiter Resource States

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

dBInstanceAvailable, dBInstanceDeleted, dBSnapshotAvailable, dBSnapshotDeleted, dBClusterSnapshotAvailable, dBClusterSnapshotDeleted, dBClusterAvailable, dBClusterDeleted, tenantDatabaseAvailable, tenantDatabaseDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

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

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

Examples:

Constructing a RDS object

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

Options Hash (options):

  • params (map)

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

  • endpoint (String|AWS.Endpoint)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates an Identity and Access Management (IAM) role with a DB cluster.

Service Reference:

Examples:

Calling the addRoleToDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  FeatureName: 'STRING_VALUE'
};
rds.addRoleToDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the DB cluster to associate the IAM role with.

    • RoleArn — (String)

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

    • FeatureName — (String)

      The name of the feature for the DB cluster 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.

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

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

Note: To add a role to a DB instance, the status of the DB instance must be available.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the addRoleToDBInstance operation

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.

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

Adds a source identifier to an existing RDS event notification subscription.

Examples:

Calling the addSourceIdentifierToSubscription operation

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.

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

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

Service Reference:

Examples:

Calling the addTagsToResource operation

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.

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

Applies a pending maintenance action to a resource (for example, to a DB instance).

Service Reference:

Examples:

Calling the applyPendingMaintenanceAction operation

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. Valid actions are system-update, db-upgrade, hardware-maintenance, and 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.

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

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Note: EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the authorizeDBSecurityGroupIngress operation

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.

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

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

Note: This action applies only to Aurora MySQL DB clusters.

Service Reference:

Examples:

Calling the backtrackDBCluster operation

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.

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

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.

Service Reference:

Examples:

Calling the cancelExportTask operation

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.

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

Copies the specified DB cluster parameter group.

Note: You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.

Service Reference:

Examples:

Calling the copyDBClusterParameterGroup operation

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

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

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

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

  • KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

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

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

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 DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the copyDBClusterSnapshot operation

var params = {
  SourceDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  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.

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

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

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

Copies the specified DB parameter group.

Note: You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.

Service Reference:

Examples:

Calling the copyDBParameterGroup operation

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.

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

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

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

This command doesn't apply to RDS Custom.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the copyDBSnapshot operation

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.

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

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

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

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

Copies the specified option group.

Service Reference:

Examples:

Calling the copyOptionGroup operation

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.

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

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

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

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.

Service Reference:

Examples:

Calling the createBlueGreenDeployment operation

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.

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

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

Creates a custom DB engine version (CEV).

Service Reference:

Examples:

Calling the createCustomDBEngineVersion operation

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 to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.

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

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

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

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

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

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

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

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBCluster operation

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',
  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,
  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 DB instances in the DB cluster can be created.

      For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

      Valid for Cluster Type: Aurora DB clusters only

    • 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. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

      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.

      • Must not be default.

      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

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

      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.

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

      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

      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, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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

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

          Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB cluster.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • GlobalWriteForwardingStatus — (String)

          The status of write forwarding for a secondary cluster in an Aurora global database.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

        • PendingModifiedValues — (map)

          Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • DBClusterIdentifier — (String)

            The DBClusterIdentifier value for the DB cluster.

          • MasterUserPassword — (String)

            The master credentials for the DB cluster.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • EngineVersion — (String)

            The database engine version.

          • BackupRetentionPeriod — (Integer)

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

          • AllocatedStorage — (Integer)

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

          • 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"
          • Iops — (Integer)

            The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

          • StorageType — (String)

            The storage type for the DB cluster.

        • DBClusterInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

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

        • StorageType — (String)

          The storage type associated with the DB cluster.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value.

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

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB cluster is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.

          For more information, see CreateDBCluster.

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

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

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

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

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

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

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

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB cluster.

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

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

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

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

          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

        • ServerlessV2ScalingConfiguration — (map)

          The scaling configuration for 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 instance.

          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.

          This setting is only for Aurora DB clusters.

          Valid Values: IPV4 | DUAL

        • DBSystemId — (String)

          Reserved for future use.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

          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.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • IOOptimizedNextAllowedModificationTime — (Date)

          The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

          This setting is only for Aurora DB clusters.

        • LocalWriteForwardingStatus — (String)

          Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "requested"
        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • LimitlessDatabase — (map)

          The details for Aurora Limitless Database.

          • Status — (String)

            The status of Aurora Limitless Database.

            Possible values include:
            • "active"
            • "not-in-use"
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "modifying-max-capacity"
            • "error"
          • MinRequiredACU — (Float)

            The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).

        • StorageThroughput — (Integer)

          The storage throughput for the DB cluster. 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.

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

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

Note: This action applies only to Aurora DB clusters.

Service Reference:

Examples:

Calling the createDBClusterEndpoint operation

var params = {
  DBClusterEndpointIdentifier: 'STRING_VALUE', /* required */
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  EndpointType: 'STRING_VALUE', /* required */
  ExcludedMembers: [
    'STRING_VALUE',
    /* more items */
  ],
  StaticMembers: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createDBClusterEndpoint(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 associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterEndpointIdentifier — (String)

      The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    • EndpointType — (String)

      The type of the endpoint, one of: READER, WRITER, ANY.

    • StaticMembers — (Array<String>)

      List of DB instance identifiers that are part of the custom endpoint group.

    • ExcludedMembers — (Array<String>)

      List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.

    • 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. The data object has the following properties:

      • DBClusterEndpointIdentifier — (String)

        The identifier associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterIdentifier — (String)

        The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterEndpointResourceIdentifier — (String)

        A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

      • Endpoint — (String)

        The DNS address of the endpoint.

      • Status — (String)

        The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

      • EndpointType — (String)

        The type of the endpoint. One of: READER, WRITER, CUSTOM.

      • CustomEndpointType — (String)

        The type associated with a custom endpoint. One of: READER, WRITER, ANY.

      • StaticMembers — (Array<String>)

        List of DB instance identifiers that are part of the custom endpoint group.

      • ExcludedMembers — (Array<String>)

        List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

      • DBClusterEndpointArn — (String)

        The Amazon Resource Name (ARN) for the endpoint.

Returns:

  • (AWS.Request)

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

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

Creates a new DB cluster parameter group.

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

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createDBClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the DB cluster parameter group.

      Constraints:

      • Must not match the name of an existing DB cluster parameter group.

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

      The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

      Aurora MySQL

      Example: aurora-mysql5.7, aurora-mysql8.0

      Aurora PostgreSQL

      Example: aurora-postgresql14

      RDS for MySQL

      Example: mysql8.0

      RDS for PostgreSQL

      Example: postgres13

      To list all of the available parameter group families for a DB engine, use the following command:

      aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

      For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

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

      Note: The output contains duplicates.

      The following are the valid DB engine values:

      • aurora-mysql

      • aurora-postgresql

      • mysql

      • postgres

    • Description — (String)

      The description for the DB cluster parameter group.

    • Tags — (Array<map>)

      Tags to assign to the DB cluster parameter group.

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

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

Creates a snapshot of a DB cluster.

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBClusterSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createDBClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

      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-cluster1-snapshot1

    • DBClusterIdentifier — (String)

      The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Example: my-cluster1

    • Tags — (Array<map>)

      The tags to be assigned to the DB cluster snapshot.

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

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

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

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

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

Service Reference:

Examples:

Calling the createDBInstance operation

var params = {
  DBInstanceClass: 'STRING_VALUE', /* required */
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  BackupTarget: 'STRING_VALUE',
  CACertificateIdentifier: 'STRING_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  CustomIamInstanceProfile: 'STRING_VALUE',
  DBClusterIdentifier: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DBSystemId: 'STRING_VALUE',
  DedicatedLogVolume: true || false,
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainAuthSecretArn: 'STRING_VALUE',
  DomainDnsIps: [
    'STRING_VALUE',
    /* more items */
  ],
  DomainFqdn: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  DomainOu: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableCustomerOwnedIp: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LicenseModel: 'STRING_VALUE',
  ManageMasterUserPassword: true || false,
  MasterUserPassword: 'STRING_VALUE',
  MasterUserSecretKmsKeyId: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  MultiTenant: true || false,
  NcharCharacterSetName: 'STRING_VALUE',
  NetworkType: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  PerformanceInsightsRetentionPeriod: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ProcessorFeatures: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PromotionTier: 'NUMBER_VALUE',
  PubliclyAccessible: true || false,
  StorageEncrypted: true || false,
  StorageThroughput: 'NUMBER_VALUE',
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  Timezone: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.createDBInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The meaning of this parameter differs according to the database engine you use.

      Amazon Aurora MySQL

      The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.

      Constraints:

      • Must contain 1 to 64 alphanumeric characters.

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

      Amazon Aurora PostgreSQL

      The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.

      Constraints:

      • It must contain 1 to 63 alphanumeric characters.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).

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

      Amazon RDS Custom for Oracle

      The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.

      Default: ORCL

      Constraints:

      • Must contain 1 to 8 alphanumeric characters.

      • Must contain a letter.

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

      Amazon RDS Custom for SQL Server

      Not applicable. Must be null.

      RDS for Db2

      The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

      Constraints:

      • Must contain 1 to 64 letters or numbers.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      • Can't be a word reserved by the specified database engine.

      RDS for MariaDB

      The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

      Constraints:

      • Must contain 1 to 64 letters or numbers.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      • Can't be a word reserved by the specified database engine.

      RDS for MySQL

      The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

      Constraints:

      • Must contain 1 to 64 letters or numbers.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      • Can't be a word reserved by the specified database engine.

      RDS for Oracle

      The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is ORCL. You can't specify the string null, or any other reserved word, for DBName.

      Default: ORCL

      Constraints:

      • Can't be longer than 8 characters.

      RDS for PostgreSQL

      The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.

      Constraints:

      • Must contain 1 to 63 letters, numbers, or underscores.

      • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

      • Can't be a word reserved by the specified database engine.

      RDS for SQL Server

      Not applicable. Must be null.

    • DBInstanceIdentifier — (String)

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

      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: mydbinstance

    • AllocatedStorage — (Integer)

      The amount of storage in gibibytes (GiB) to allocate for the DB instance.

      This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

      Amazon RDS Custom

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

      • Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

      RDS for Db2

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.

      • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

      RDS for MariaDB

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

      • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      • Magnetic storage (standard): Must be an integer from 5 to 3072.

      RDS for MySQL

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

      • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      • Magnetic storage (standard): Must be an integer from 5 to 3072.

      RDS for Oracle

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

      • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      • Magnetic storage (standard): Must be an integer from 10 to 3072.

      RDS for PostgreSQL

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

      • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

      • Magnetic storage (standard): Must be an integer from 5 to 3072.

      RDS for SQL Server

      Constraints to the amount of storage for each storage type are the following:

      • General Purpose (SSD) storage (gp2, gp3):

        • Enterprise and Standard editions: Must be an integer from 20 to 16384.

        • Web and Express editions: Must be an integer from 20 to 16384.

      • Provisioned IOPS storage (io1):

        • Enterprise and Standard editions: Must be an integer from 100 to 16384.

        • Web and Express editions: Must be an integer from 100 to 16384.

      • Magnetic storage (standard):

        • Enterprise and Standard editions: Must be an integer from 20 to 1024.

        • Web and Express editions: Must be an integer from 20 to 1024.

    • DBInstanceClass — (String)

      The compute and memory capacity of the DB instance, for example db.m5.large. 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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

    • Engine — (String)

      The database engine to use for this DB instance.

      Not every database engine is available in every Amazon Web Services Region.

      Valid Values:

      • aurora-mysql (for Aurora MySQL DB instances)

      • aurora-postgresql (for Aurora PostgreSQL DB instances)

      • custom-oracle-ee (for RDS Custom for Oracle DB instances)

      • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

      • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

      • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

      • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • MasterUsername — (String)

      The name for the master user.

      This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

      This setting is required for RDS DB instances.

      Constraints:

      • Must be 1 to 16 letters, numbers, or underscores.

      • First character must be a letter.

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

    • MasterUserPassword — (String)

      The password for the master user.

      This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.

      Constraints:

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

      • Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.

      Length Constraints:

      • RDS for Db2 - Must contain from 8 to 255 characters.

      • RDS for MariaDB - Must contain from 8 to 41 characters.

      • RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

      • RDS for MySQL - Must contain from 8 to 41 characters.

      • RDS for Oracle - Must contain from 8 to 30 characters.

      • RDS for PostgreSQL - Must contain from 8 to 128 characters.

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to associate with this DB instance.

      This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

    • VpcSecurityGroupIds — (Array<String>)

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

      This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

    • AvailabilityZone — (String)

      The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

      For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

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

      Constraints:

      • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.

      • The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

      Example: us-east-1d

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB instance.

      Constraints:

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

      • Must not be default.

      Example: mydbsubnetgroup

    • PreferredMaintenanceWindow — (String)

      The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

      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.

      Constraints:

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

      • The day values must be mon | tue | wed | thu | fri | sat | sun.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred backup window.

      • Must be at least 30 minutes.

    • DBParameterGroupName — (String)

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

      This setting doesn't apply to RDS Custom DB instances.

      Constraints:

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

      • The first character must be a letter.

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

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

      Default: 1

      Constraints:

      • Must be a value from 0 to 35.

      • Can't be set to 0 if the DB instance is a source to read replicas.

      • Can't be set to 0 for an RDS Custom for Oracle DB instance.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

      This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.

      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.

    • Port — (Integer)

      The port number on which the database accepts connections.

      This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

      Valid Values: 1150-65535

      Default:

      • RDS for Db2 - 50000

      • RDS for MariaDB - 3306

      • RDS for Microsoft SQL Server - 1433

      • RDS for MySQL - 3306

      • RDS for Oracle - 1521

      • RDS for PostgreSQL - 5432

      Constraints:

      • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.

    • MultiAZ — (Boolean)

      Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

      • RDS Custom

    • EngineVersion — (String)

      The version number of the database engine to use.

      This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.

      For a list of valid engine versions, use the DescribeDBEngineVersions operation.

      The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

      Amazon RDS Custom for Oracle

      A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

      Amazon RDS Custom for SQL Server

      See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

      RDS for Db2

      For information, see Db2 on Amazon RDS versions in the Amazon RDS User Guide.

      RDS for MariaDB

      For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.

      RDS for Microsoft SQL Server

      For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.

      RDS for MySQL

      For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.

      RDS for Oracle

      For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.

      RDS for PostgreSQL

      For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

    • AutoMinorVersionUpgrade — (Boolean)

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

      If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.

    • LicenseModel — (String)

      The license model information for this DB instance.

      This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

      Valid Values:

      • RDS for Db2 - bring-your-own-license

      • RDS for MariaDB - general-public-license

      • RDS for Microsoft SQL Server - license-included

      • RDS for MySQL - general-public-license

      • RDS for Oracle - bring-your-own-license | license-included

      • RDS for PostgreSQL - postgresql-license

    • Iops — (Integer)

      The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.

      This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

      Constraints:

      • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.

      • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    • OptionGroupName — (String)

      The option group to associate the DB instance with.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.

      This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    • CharacterSetName — (String)

      For supported engines, the character set (CharacterSet) to associate the DB instance with.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster.

      • RDS Custom - However, if you need to change the character set, you can change it on the database itself.

    • NcharCharacterSetName — (String)

      The name of the NCHAR character set for the Oracle DB instance.

      This setting doesn't apply to RDS Custom DB instances.

    • PubliclyAccessible — (Boolean)

      Specifies whether the DB instance is publicly accessible.

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

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

      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 instance is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB instance 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 instance is private.

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

    • Tags — (Array<map>)

      Tags to assign to the DB instance.

      • 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}.:/=+\-@]*)$").

    • DBClusterIdentifier — (String)

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

      This setting doesn't apply to RDS Custom DB instances.

    • StorageType — (String)

      The storage type to associate with the DB instance.

      If you specify io1 or gp3, you must also include a value for the Iops parameter.

      This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

      Valid Values: gp2 | gp3 | io1 | standard

      Default: io1, if the Iops parameter is specified. Otherwise, gp2.

    • TdeCredentialArn — (String)

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

      This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the key store in order to access the device.

      This setting doesn't apply to RDS Custom DB instances.

    • StorageEncrypted — (Boolean)

      Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

      For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

      This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

    • KmsKeyId — (String)

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

      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.

      This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

      If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, 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.

      For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.

    • Domain — (String)

      The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (The domain is managed by the DB cluster.)

      • RDS Custom

    • DomainFqdn — (String)

      The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

    • DomainOu — (String)

      The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    • DomainAuthSecretArn — (String)

      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

    • DomainDnsIps — (Array<String>)

      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

    • CopyTagsToSnapshot — (Boolean)

      Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

      This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

      If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

      This setting doesn't apply to RDS Custom DB instances.

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

      Default: 0

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, 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, then you must supply a MonitoringRoleArn value.

      This setting doesn't apply to RDS Custom DB instances.

    • DomainIAMRoleName — (String)

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

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (The domain is managed by the DB cluster.)

      • RDS Custom

    • PromotionTier — (Integer)

      The order of priority 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.

      This setting doesn't apply to RDS Custom DB instances.

      Default: 1

      Valid Values: 0 - 15

    • Timezone — (String)

      The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

    • 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 for MySQL and PostgreSQL in the Amazon RDS User Guide.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

      • RDS Custom

    • EnablePerformanceInsights — (Boolean)

      Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom DB instances.

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

      This setting doesn't apply to RDS Custom DB instances.

    • PerformanceInsightsRetentionPeriod — (Integer)

      The number of days to retain Performance Insights data.

      This setting doesn't apply to RDS Custom DB instances.

      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 returns an error.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of log types to enable for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

      • RDS Custom

      The following values are valid for each DB engine:

      • RDS for Db2 - diag.log | notify.log

      • RDS for MariaDB - audit | error | general | slowquery

      • RDS for Microsoft SQL Server - agent | error

      • RDS for MySQL - audit | error | general | slowquery

      • RDS for Oracle - alert | audit | listener | trace | oemagent

      • RDS for PostgreSQL - postgresql | upgrade

    • ProcessorFeatures — (Array<map>)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

      • Name — (String)

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

      • Value — (String)

        The value of a processor feature name.

    • DeletionProtection — (Boolean)

      Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

      This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

    • MaxAllocatedStorage — (Integer)

      The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

      For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

      This setting doesn't apply to the following DB instances:

      • Amazon Aurora (Storage is managed by the DB cluster.)

      • RDS Custom

    • EnableCustomerOwnedIp — (Boolean)

      Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

      A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

      For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

    • CustomIamInstanceProfile — (String)

      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

      This setting is required for RDS Custom.

      Constraints:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

    • BackupTarget — (String)

      The location for storing automated backups and manual snapshots.

      Valid Values:

      • outposts (Amazon Web Services Outposts)

      • region (Amazon Web Services Region)

      Default: region

      For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

    • NetworkType — (String)

      The network type of the DB instance.

      The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide.

      Valid Values: IPV4 | DUAL

    • StorageThroughput — (Integer)

      The storage throughput value for the DB instance.

      This setting applies only to the gp3 storage type.

      This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

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

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

      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.

    • CACertificateIdentifier — (String)

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

      This setting doesn't apply to RDS Custom DB instances.

      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.

    • DBSystemId — (String)

      The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. 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)

      Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines.

      Note the following restrictions:

      • The DB engine that you specify in the request must support the multi-tenant configuration. If you attempt to enable the multi-tenant configuration on a DB engine that doesn't support it, the request fails.

      • If you specify the multi-tenant configuration when you create your DB instance, you can't later modify this DB instance to use the single-tenant configuration.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

        • DBInstanceIdentifier — (String)

          The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The database engine used for this DB instance.

        • DBInstanceStatus — (String)

          The current state of this database.

          For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB instance is restarted automatically.

        • MasterUsername — (String)

          The master username for the DB instance.

        • DBName — (String)

          The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

        • Endpoint — (map)

          The connection endpoint for the DB instance.

          Note: The endpoint might not be shown for instances with the status of creating.
          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • AllocatedStorage — (Integer)

          The amount of storage in gibibytes (GiB) allocated for the DB instance.

        • InstanceCreateTime — (Date)

          The date and time when the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

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

        • DBSecurityGroups — (Array<map>)

          A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          The list of Amazon EC2 VPC security groups that the DB instance 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.

        • DBParameterGroups — (Array<map>)

          The list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DB parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          The name of the Availability Zone where the DB instance is located.

        • DBSubnetGroup — (map)

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

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              The identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the OrderableDBInstanceOption data type.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetOutpost — (map)

              If the subnet is associated with an Outpost, this value specifies the Outpost.

              For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the Outpost.

            • SubnetStatus — (String)

              The status of the subnet.

          • DBSubnetGroupArn — (String)

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

          • SupportedNetworkTypes — (Array<String>)

            The network type of the DB subnet group.

            Valid values:

            • IPV4

            • DUAL

            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 RDS User Guide.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            The name of the compute and memory capacity class for the DB instance.

          • AllocatedStorage — (Integer)

            The allocated storage size for the DB instance specified in gibibytes (GiB).

          • MasterUserPassword — (String)

            The master credentials for the DB instance.

          • Port — (Integer)

            The port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            The number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

          • EngineVersion — (String)

            The database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

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

          • Iops — (Integer)

            The Provisioned IOPS value for the DB instance.

          • DBInstanceIdentifier — (String)

            The database identifier for the DB instance.

          • StorageType — (String)

            The storage type of the DB instance.

          • CACertificateIdentifier — (String)

            The identifier of the CA certificate for the DB instance.

            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.

          • DBSubnetGroupName — (String)

            The DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • ProcessorFeatures — (Array<map>)

            The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

            • Name — (String)

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

            • Value — (String)

              The value of a processor feature name.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • AutomationMode — (String)

            The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

            Possible values include:
            • "full"
            • "all-paused"
          • ResumeFullAutomationModeTime — (Date)

            The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

          • StorageThroughput — (Integer)

            The storage throughput of the DB instance.

          • Engine — (String)

            The database engine of the DB instance.

          • DedicatedLogVolume — (Boolean)

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

          • MultiTenant — (Boolean)

            Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

        • EngineVersion — (String)

          The version of the database engine.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          The identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

          Note: Currently, each RDS DB instance can have only one Aurora read replica.
        • ReplicaMode — (String)

          The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

          Note: This attribute is only supported in RDS for Oracle.
          Possible values include:
          • "open-read-only"
          • "mounted"
        • LicenseModel — (String)

          The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value for the DB instance.

        • OptionGroupMemberships — (Array<map>)

          The list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

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

        • NcharCharacterSetName — (String)

          The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB instance is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the DB instance isn't a read replica, the value is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

          • Status — (String)

            The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

          • Message — (String)

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

        • StorageType — (String)

          The storage type associated with the DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Indicates whether the DB instance is encrypted.

        • KmsKeyId — (String)

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

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

        • DbiResourceId — (String)

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

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

          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.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB instance.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • CopyTagsToSnapshot — (Boolean)

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

          This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          The order of priority 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.

        • DBInstanceArn — (String)

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

        • Timezone — (String)

          The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for 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 for the DB instance.

          For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB instance.

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

          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

        • EnabledCloudwatchLogsExports — (Array<String>)

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

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

        • ProcessorFeatures — (Array<map>)

          The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

          • Name — (String)

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

          • Value — (String)

            The value of a processor feature name.

        • DeletionProtection — (Boolean)

          Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

        • AssociatedRoles — (Array<map>)

          The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

          • RoleArn — (String)

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

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

          • Status — (String)

            Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

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

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

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

        • ListenerEndpoint — (map)

          The listener connection endpoint for SQL Server Always On.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • MaxAllocatedStorage — (Integer)

          The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • DBInstanceAutomatedBackupsReplications — (Array<map>)

          The list of replicated automated backups associated with the DB instance.

          • DBInstanceAutomatedBackupsArn — (String)

            The Amazon Resource Name (ARN) of the replicated automated backups.

        • CustomerOwnedIpEnabled — (Boolean)

          Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

          A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

          For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

          For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

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

        • ActivityStreamMode — (String)

          The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

          Possible values include:
          • "sync"
          • "async"
        • ActivityStreamEngineNativeAuditFieldsIncluded — (Boolean)

          Indicates whether engine-native audit fields are included in the database activity stream.

        • AutomationMode — (String)

          The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

          Possible values include:
          • "full"
          • "all-paused"
        • ResumeFullAutomationModeTime — (Date)

          The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

        • CustomIamInstanceProfile — (String)

          The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

          • The profile must exist in your account.

          • The profile must have an IAM role that Amazon EC2 has permissions to assume.

          • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

          For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

        • BackupTarget — (String)

          The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

        • NetworkType — (String)

          The network type of the DB instance.

          The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

          Valid Values: IPV4 | DUAL

        • ActivityStreamPolicyStatus — (String)

          The status of the policy state of the activity stream.

          Possible values include:
          • "locked"
          • "unlocked"
          • "locking-policy"
          • "unlocking-policy"
        • StorageThroughput — (Integer)

          The storage throughput for the DB instance.

          This setting applies only to the gp3 storage type.

        • DBSystemId — (String)

          The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

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

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • CertificateDetails — (map)

          The details of the DB instance's server certificate.

          • CAIdentifier — (String)

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

          • ValidTill — (Date)

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

        • ReadReplicaSourceDBClusterIdentifier — (String)

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

        • PercentProgress — (String)

          The progress of the storage optimization operation as a percentage.

        • DedicatedLogVolume — (Boolean)

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

        • IsStorageConfigUpgradeAvailable — (Boolean)

          Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

        • MultiTenant — (Boolean)

          Specifies whether the DB instance is in 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.

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

Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.

All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.

Your source DB instance or cluster must have backup retention enabled.

Service Reference:

Examples:

Calling the createDBInstanceReadReplica operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  CustomIamInstanceProfile: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DedicatedLogVolume: true || false,
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainAuthSecretArn: 'STRING_VALUE',
  DomainDnsIps: [
    'STRING_VALUE',
    /* more items */
  ],
  DomainFqdn: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  DomainOu: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableCustomerOwnedIp: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  NetworkType: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  PerformanceInsightsRetentionPeriod: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  ProcessorFeatures: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PubliclyAccessible: true || false,
  ReplicaMode: open-read-only | mounted,
  SourceDBClusterIdentifier: 'STRING_VALUE',
  SourceDBInstanceIdentifier: 'STRING_VALUE',
  SourceRegion: 'STRING_VALUE',
  StorageThroughput: 'NUMBER_VALUE',
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UpgradeStorageConfig: true || false,
  UseDefaultProcessorFeatures: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.createDBInstanceReadReplica(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 DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

    • SourceDBInstanceIdentifier — (String)

      The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.

      Constraints:

      • Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.

      • Can't be specified if the SourceDBClusterIdentifier parameter is also specified.

      • For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.

      • For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.

      • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

      • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

      • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.

    • DBInstanceClass — (String)

      The compute and memory capacity of the read replica, for example db.m4.large. 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.

      Default: Inherits the value from the source DB instance.

    • AvailabilityZone — (String)

      The Availability Zone (AZ) where the read replica will be created.

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

      Example: us-east-1d

    • Port — (Integer)

      The port number that the DB instance uses for connections.

      Valid Values: 1150-65535

      Default: Inherits the value from the source DB instance.

    • MultiAZ — (Boolean)

      Specifies whether the read replica is in a Multi-AZ deployment.

      You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.

      This setting doesn't apply to RDS Custom DB instances.

    • AutoMinorVersionUpgrade — (Boolean)

      Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.

      This setting doesn't apply to RDS Custom DB instances.

      Default: Inherits the value from the source DB instance.

    • Iops — (Integer)

      The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.

    • OptionGroupName — (String)

      The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.

      Note: For SQL Server, you must use the option group associated with the source.

      This setting doesn't apply to RDS Custom DB instances.

    • DBParameterGroupName — (String)

      The name of the DB parameter group to associate with this DB instance.

      If you don't specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.

      Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom.

      Constraints:

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

      • First character must be a letter.

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

    • PubliclyAccessible — (Boolean)

      Specifies whether the DB instance is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

      For more information, see CreateDBInstance.

    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

    • DBSubnetGroupName — (String)

      A DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

      Constraints:

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

      • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

      • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:

        • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

        • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

      Example: mydbsubnetgroup

    • VpcSecurityGroupIds — (Array<String>)

      A list of Amazon EC2 VPC security groups to associate with the read replica.

      This setting doesn't apply to RDS Custom DB instances.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

    • StorageType — (String)

      The storage type to associate with the read replica.

      If you specify io1 or gp3, you must also include a value for the Iops parameter.

      Valid Values: gp2 | gp3 | io1 | standard

      Default: io1 if the Iops parameter is specified. Otherwise, gp2.

    • CopyTagsToSnapshot — (Boolean)

      Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

      If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

      This setting doesn't apply to RDS Custom DB instances.

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

      Default: 0

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

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

      This setting doesn't apply to RDS Custom DB instances.

    • KmsKeyId — (String)

      The Amazon Web Services KMS key identifier for an encrypted read replica.

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

      If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.

      If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a 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.

      You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.

      This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.

    • PreSignedUrl — (String)

      When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.

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

      This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

      You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

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

      • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL.

        For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica 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 key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

      • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-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. SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.

      This setting doesn't apply to RDS Custom DB instances.

      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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom DB instances.

    • EnablePerformanceInsights — (Boolean)

      Specifies whether to enable Performance Insights for the read replica.

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

      This setting doesn't apply to RDS Custom DB instances.

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

      This setting doesn't apply to RDS Custom DB instances.

    • PerformanceInsightsRetentionPeriod — (Integer)

      The number of days to retain Performance Insights data.

      This setting doesn't apply to RDS Custom DB instances.

      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 returns an error.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom DB instances.

    • ProcessorFeatures — (Array<map>)

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      This setting doesn't apply to RDS Custom DB instances.

      • Name — (String)

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

      • Value — (String)

        The value of a processor feature name.

    • UseDefaultProcessorFeatures — (Boolean)

      Specifies whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom DB instances.

    • DeletionProtection — (Boolean)

      Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.

    • Domain — (String)

      The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom DB instances.

    • DomainIAMRoleName — (String)

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

      This setting doesn't apply to RDS Custom DB instances.

    • DomainFqdn — (String)

      The fully qualified domain name (FQDN) of an Active Directory domain.

      Constraints:

      • Can't be longer than 64 characters.

      Example: mymanagedADtest.mymanagedAD.mydomain

    • DomainOu — (String)

      The Active Directory organizational unit for your DB instance to join.

      Constraints:

      • Must be in the distinguished name format.

      • Can't be longer than 64 characters.

      Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

    • DomainAuthSecretArn — (String)

      The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

      Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

    • DomainDnsIps — (Array<String>)

      The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

      Constraints:

      • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

      Example: 123.124.125.126,234.235.236.237

    • ReplicaMode — (String)

      The open mode of the replica database: mounted or read-only.

      Note: This parameter is only supported for Oracle DB instances.

      Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

      You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

      For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.

      Possible values include:
      • "open-read-only"
      • "mounted"
    • MaxAllocatedStorage — (Integer)

      The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

      For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

    • CustomIamInstanceProfile — (String)

      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

      This setting is required for RDS Custom DB instances.

    • NetworkType — (String)

      The network type of the DB instance.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for read replica. 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 RDS User Guide.

    • StorageThroughput — (Integer)

      Specifies the storage throughput value for the read replica.

      This setting doesn't apply to RDS Custom or Amazon Aurora DB instances.

    • EnableCustomerOwnedIp — (Boolean)

      Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.

      A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.

      For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

      For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

    • AllocatedStorage — (Integer)

      The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.

      Note: Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
    • SourceDBClusterIdentifier — (String)

      The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.

      Constraints:

      • Must be the identifier of an existing Multi-AZ DB cluster.

      • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.

      • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.

      • The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.

    • DedicatedLogVolume — (Boolean)

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

    • UpgradeStorageConfig — (Boolean)

      Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.

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

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

        • DBInstanceIdentifier — (String)

          The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The database engine used for this DB instance.

        • DBInstanceStatus — (String)

          The current state of this database.

          For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB instance is restarted automatically.

        • MasterUsername — (String)

          The master username for the DB instance.

        • DBName — (String)

          The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

        • Endpoint — (map)

          The connection endpoint for the DB instance.

          Note: The endpoint might not be shown for instances with the status of creating.
          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • AllocatedStorage — (Integer)

          The amount of storage in gibibytes (GiB) allocated for the DB instance.

        • InstanceCreateTime — (Date)

          The date and time when the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

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

        • DBSecurityGroups — (Array<map>)

          A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          The list of Amazon EC2 VPC security groups that the DB instance 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.

        • DBParameterGroups — (Array<map>)

          The list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DB parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          The name of the Availability Zone where the DB instance is located.

        • DBSubnetGroup — (map)

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

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              The identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the OrderableDBInstanceOption data type.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetOutpost — (map)

              If the subnet is associated with an Outpost, this value specifies the Outpost.

              For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the Outpost.

            • SubnetStatus — (String)

              The status of the subnet.

          • DBSubnetGroupArn — (String)

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

          • SupportedNetworkTypes — (Array<String>)

            The network type of the DB subnet group.

            Valid values:

            • IPV4

            • DUAL

            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 RDS User Guide.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            The name of the compute and memory capacity class for the DB instance.

          • AllocatedStorage — (Integer)

            The allocated storage size for the DB instance specified in gibibytes (GiB).

          • MasterUserPassword — (String)

            The master credentials for the DB instance.

          • Port — (Integer)

            The port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            The number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

          • EngineVersion — (String)

            The database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

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

          • Iops — (Integer)

            The Provisioned IOPS value for the DB instance.

          • DBInstanceIdentifier — (String)

            The database identifier for the DB instance.

          • StorageType — (String)

            The storage type of the DB instance.

          • CACertificateIdentifier — (String)

            The identifier of the CA certificate for the DB instance.

            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.

          • DBSubnetGroupName — (String)

            The DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • ProcessorFeatures — (Array<map>)

            The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

            • Name — (String)

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

            • Value — (String)

              The value of a processor feature name.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • AutomationMode — (String)

            The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

            Possible values include:
            • "full"
            • "all-paused"
          • ResumeFullAutomationModeTime — (Date)

            The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

          • StorageThroughput — (Integer)

            The storage throughput of the DB instance.

          • Engine — (String)

            The database engine of the DB instance.

          • DedicatedLogVolume — (Boolean)

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

          • MultiTenant — (Boolean)

            Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

        • EngineVersion — (String)

          The version of the database engine.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          The identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

          Note: Currently, each RDS DB instance can have only one Aurora read replica.
        • ReplicaMode — (String)

          The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

          Note: This attribute is only supported in RDS for Oracle.
          Possible values include:
          • "open-read-only"
          • "mounted"
        • LicenseModel — (String)

          The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value for the DB instance.

        • OptionGroupMemberships — (Array<map>)

          The list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

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

        • NcharCharacterSetName — (String)

          The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB instance is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the DB instance isn't a read replica, the value is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

          • Status — (String)

            The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

          • Message — (String)

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

        • StorageType — (String)

          The storage type associated with the DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Indicates whether the DB instance is encrypted.

        • KmsKeyId — (String)

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

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

        • DbiResourceId — (String)

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

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

          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.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB instance.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • CopyTagsToSnapshot — (Boolean)

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

          This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          The order of priority 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.

        • DBInstanceArn — (String)

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

        • Timezone — (String)

          The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for 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 for the DB instance.

          For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB instance.

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

          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

        • EnabledCloudwatchLogsExports — (Array<String>)

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

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

        • ProcessorFeatures — (Array<map>)

          The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

          • Name — (String)

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

          • Value — (String)

            The value of a processor feature name.

        • DeletionProtection — (Boolean)

          Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

        • AssociatedRoles — (Array<map>)

          The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

          • RoleArn — (String)

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

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

          • Status — (String)

            Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

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

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

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

        • ListenerEndpoint — (map)

          The listener connection endpoint for SQL Server Always On.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • MaxAllocatedStorage — (Integer)

          The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • DBInstanceAutomatedBackupsReplications — (Array<map>)

          The list of replicated automated backups associated with the DB instance.

          • DBInstanceAutomatedBackupsArn — (String)

            The Amazon Resource Name (ARN) of the replicated automated backups.

        • CustomerOwnedIpEnabled — (Boolean)

          Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

          A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

          For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

          For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

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

        • ActivityStreamMode — (String)

          The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

          Possible values include:
          • "sync"
          • "async"
        • ActivityStreamEngineNativeAuditFieldsIncluded — (Boolean)

          Indicates whether engine-native audit fields are included in the database activity stream.

        • AutomationMode — (String)

          The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

          Possible values include:
          • "full"
          • "all-paused"
        • ResumeFullAutomationModeTime — (Date)

          The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

        • CustomIamInstanceProfile — (String)

          The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

          • The profile must exist in your account.

          • The profile must have an IAM role that Amazon EC2 has permissions to assume.

          • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

          For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

        • BackupTarget — (String)

          The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

        • NetworkType — (String)

          The network type of the DB instance.

          The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

          Valid Values: IPV4 | DUAL

        • ActivityStreamPolicyStatus — (String)

          The status of the policy state of the activity stream.

          Possible values include:
          • "locked"
          • "unlocked"
          • "locking-policy"
          • "unlocking-policy"
        • StorageThroughput — (Integer)

          The storage throughput for the DB instance.

          This setting applies only to the gp3 storage type.

        • DBSystemId — (String)

          The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

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

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • CertificateDetails — (map)

          The details of the DB instance's server certificate.

          • CAIdentifier — (String)

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

          • ValidTill — (Date)

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

        • ReadReplicaSourceDBClusterIdentifier — (String)

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

        • PercentProgress — (String)

          The progress of the storage optimization operation as a percentage.

        • DedicatedLogVolume — (Boolean)

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

        • IsStorageConfigUpgradeAvailable — (Boolean)

          Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

        • MultiTenant — (Boolean)

          Specifies whether the DB instance is in 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.

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

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn't apply to RDS Custom.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Service Reference:

Examples:

Calling the createDBParameterGroup operation

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

      The name of the DB parameter group.

      Constraints:

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

      • First character must be a letter

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

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

      The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

      To list all of the available parameter group families for a DB engine, use the following command:

      aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

      For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

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

      Note: The output contains duplicates.

      The following are the valid DB engine values:

      • aurora-mysql

      • aurora-postgresql

      • db2-ae

      • db2-se

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • Description — (String)

      The description for the DB parameter group.

    • Tags — (Array<map>)

      Tags to assign to the DB parameter group.

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

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

Creates a new DB proxy.

Service Reference:

Examples:

Calling the createDBProxy operation

var params = {
  Auth: [ /* required */
    {
      AuthScheme: SECRETS,
      ClientPasswordAuthType: MYSQL_NATIVE_PASSWORD | POSTGRES_SCRAM_SHA_256 | POSTGRES_MD5 | SQL_SERVER_AUTHENTICATION,
      Description: 'STRING_VALUE',
      IAMAuth: DISABLED | REQUIRED | ENABLED,
      SecretArn: 'STRING_VALUE',
      UserName: 'STRING_VALUE'
    },
    /* more items */
  ],
  DBProxyName: 'STRING_VALUE', /* required */
  EngineFamily: MYSQL | POSTGRESQL | SQLSERVER, /* required */
  RoleArn: 'STRING_VALUE', /* required */
  VpcSubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DebugLogging: true || false,
  IdleClientTimeout: 'NUMBER_VALUE',
  RequireTLS: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.createDBProxy(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: {})
    • DBProxyName — (String)

      The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    • EngineFamily — (String)

      The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

      Possible values include:
      • "MYSQL"
      • "POSTGRESQL"
      • "SQLSERVER"
    • Auth — (Array<map>)

      The authorization mechanism that the proxy uses.

      • Description — (String)

        A user-specified description about the authentication used by a proxy to log in as a specific database user.

      • UserName — (String)

        The name of the database user to which the proxy connects.

      • AuthScheme — (String)

        The type of authentication that the proxy uses for connections from the proxy to the underlying database.

        Possible values include:
        • "SECRETS"
      • SecretArn — (String)

        The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

      • IAMAuth — (String)

        A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

        Possible values include:
        • "DISABLED"
        • "REQUIRED"
        • "ENABLED"
      • ClientPasswordAuthType — (String)

        The type of authentication the proxy uses for connections from clients.

        Possible values include:
        • "MYSQL_NATIVE_PASSWORD"
        • "POSTGRES_SCRAM_SHA_256"
        • "POSTGRES_MD5"
        • "SQL_SERVER_AUTHENTICATION"
    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

    • VpcSubnetIds — (Array<String>)

      One or more VPC subnet IDs to associate with the new proxy.

    • VpcSecurityGroupIds — (Array<String>)

      One or more VPC security group IDs to associate with the new proxy.

    • RequireTLS — (Boolean)

      Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

    • IdleClientTimeout — (Integer)

      The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

    • DebugLogging — (Boolean)

      Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

    • Tags — (Array<map>)

      An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

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

      • DBProxy — (map)

        The DBProxy structure corresponding to the new proxy.

        • DBProxyName — (String)

          The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

        • DBProxyArn — (String)

          The Amazon Resource Name (ARN) for the proxy.

        • Status — (String)

          The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

          Possible values include:
          • "available"
          • "modifying"
          • "incompatible-network"
          • "insufficient-resource-limits"
          • "creating"
          • "deleting"
          • "suspended"
          • "suspending"
          • "reactivating"
        • EngineFamily — (String)

          The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

        • VpcId — (String)

          Provides the VPC ID of the DB proxy.

        • VpcSecurityGroupIds — (Array<String>)

          Provides a list of VPC security groups that the proxy belongs to.

        • VpcSubnetIds — (Array<String>)

          The EC2 subnet IDs for the proxy.

        • Auth — (Array<map>)

          One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

          • Description — (String)

            A user-specified description about the authentication used by a proxy to log in as a specific database user.

          • UserName — (String)

            The name of the database user to which the proxy connects.

          • AuthScheme — (String)

            The type of authentication that the proxy uses for connections from the proxy to the underlying database.

            Possible values include:
            • "SECRETS"
          • SecretArn — (String)

            The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

          • IAMAuth — (String)

            Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
            • "ENABLED"
          • ClientPasswordAuthType — (String)

            The type of authentication the proxy uses for connections from clients.

            Possible values include:
            • "MYSQL_NATIVE_PASSWORD"
            • "POSTGRES_SCRAM_SHA_256"
            • "POSTGRES_MD5"
            • "SQL_SERVER_AUTHENTICATION"
        • RoleArn — (String)

          The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

        • Endpoint — (String)

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

        • RequireTLS — (Boolean)

          Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

        • IdleClientTimeout — (Integer)

          The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

          Default: 1800 (30 minutes)

          Constraints: 1 to 28,800

        • DebugLogging — (Boolean)

          Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

        • CreatedDate — (Date)

          The date and time when the proxy was first created.

        • UpdatedDate — (Date)

          The date and time when the proxy was last updated.

Returns:

  • (AWS.Request)

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

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

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

Service Reference:

Examples:

Calling the createDBProxyEndpoint operation

var params = {
  DBProxyEndpointName: 'STRING_VALUE', /* required */
  DBProxyName: 'STRING_VALUE', /* required */
  VpcSubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetRole: READ_WRITE | READ_ONLY,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.createDBProxyEndpoint(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: {})
    • DBProxyName — (String)

      The name of the DB proxy associated with the DB proxy endpoint that you create.

    • DBProxyEndpointName — (String)

      The name of the DB proxy endpoint to create.

    • VpcSubnetIds — (Array<String>)

      The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

    • VpcSecurityGroupIds — (Array<String>)

      The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

    • TargetRole — (String)

      The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

      Possible values include:
      • "READ_WRITE"
      • "READ_ONLY"
    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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:

      • DBProxyEndpoint — (map)

        The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.

        • DBProxyEndpointName — (String)

          The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

        • DBProxyEndpointArn — (String)

          The Amazon Resource Name (ARN) for the DB proxy endpoint.

        • DBProxyName — (String)

          The identifier for the DB proxy that is associated with this DB proxy endpoint.

        • Status — (String)

          The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

          Possible values include:
          • "available"
          • "modifying"
          • "incompatible-network"
          • "insufficient-resource-limits"
          • "creating"
          • "deleting"
        • VpcId — (String)

          Provides the VPC ID of the DB proxy endpoint.

        • VpcSecurityGroupIds — (Array<String>)

          Provides a list of VPC security groups that the DB proxy endpoint belongs to.

        • VpcSubnetIds — (Array<String>)

          The EC2 subnet IDs for the DB proxy endpoint.

        • Endpoint — (String)

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

        • CreatedDate — (Date)

          The date and time when the DB proxy endpoint was first created.

        • TargetRole — (String)

          A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

          Possible values include:
          • "READ_WRITE"
          • "READ_ONLY"
        • IsDefault — (Boolean)

          Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Returns:

  • (AWS.Request)

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

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

Creates a new DB security group. DB security groups control access to a DB instance.

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

Note: EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBSecurityGroup operation

var params = {
  DBSecurityGroupDescription: 'STRING_VALUE', /* required */
  DBSecurityGroupName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createDBSecurityGroup(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 for the DB security group. This value is stored as a lowercase string.

      Constraints:

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

      • First character must be a letter

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

      • Must not be "Default"

      Example: mysecuritygroup

    • DBSecurityGroupDescription — (String)

      The description for the DB security group.

    • Tags — (Array<map>)

      Tags to assign to the DB security group.

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

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

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

Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

Valid for: Aurora DB clusters only

Service Reference:

Examples:

Calling the createDBShardGroup operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBShardGroupIdentifier: 'STRING_VALUE', /* required */
  MaxACU: 'NUMBER_VALUE', /* required */
  ComputeRedundancy: 'NUMBER_VALUE',
  PubliclyAccessible: true || false
};
rds.createDBShardGroup(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: {})
    • DBShardGroupIdentifier — (String)

      The name of the DB shard group.

    • DBClusterIdentifier — (String)

      The name of the primary DB cluster for the DB shard group.

    • ComputeRedundancy — (Integer)

      Specifies whether to create standby instances for the DB shard group. Valid values are the following:

      • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

      • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

      • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

    • MaxACU — (Float)

      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

    • PubliclyAccessible — (Boolean)

      Specifies whether the DB shard group is publicly accessible.

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

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

      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 shard group is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group 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 shard group is private.

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

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:

      • DBShardGroupResourceId — (String)

        The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

      • DBShardGroupIdentifier — (String)

        The name of the DB shard group.

      • DBClusterIdentifier — (String)

        The name of the primary DB cluster for the DB shard group.

      • MaxACU — (Float)

        The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      • ComputeRedundancy — (Integer)

        Specifies whether to create standby instances for the DB shard group. Valid values are the following:

        • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

        • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

        • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

      • Status — (String)

        The status of the DB shard group.

      • PubliclyAccessible — (Boolean)

        Indicates whether the DB shard group is publicly accessible.

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

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

        For more information, see CreateDBShardGroup.

        This setting is only for Aurora Limitless Database.

      • Endpoint — (String)

        The connection endpoint for the DB shard group.

Returns:

  • (AWS.Request)

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

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

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

Service Reference:

Examples:

Calling the createDBSnapshot operation

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

      The identifier for the DB 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-snapshot-id

    • DBInstanceIdentifier — (String)

      The identifier of the DB instance that you want to create the snapshot of.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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:

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

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

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

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

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Service Reference:

Examples:

Calling the createDBSubnetGroup operation

var params = {
  DBSubnetGroupDescription: 'STRING_VALUE', /* required */
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createDBSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

      • Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

      • Must not be default.

      • First character must be a letter.

      Example: mydbsubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the DB subnet group.

    • SubnetIds — (Array<String>)

      The EC2 Subnet IDs for the DB subnet group.

    • Tags — (Array<map>)

      Tags to assign to the DB subnet group.

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

      • DBSubnetGroup — (map)

        Contains the details of an Amazon RDS DB subnet group.

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

        • DBSubnetGroupName — (String)

          The name of the DB subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the DB subnet group.

        • VpcId — (String)

          Provides the VpcId of the DB subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the DB subnet group.

        • Subnets — (Array<map>)

          Contains a list of Subnet elements.

          • SubnetIdentifier — (String)

            The identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Contains Availability Zone information.

            This data type is used as an element in the OrderableDBInstanceOption data type.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetOutpost — (map)

            If the subnet is associated with an Outpost, this value specifies the Outpost.

            For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

            • Arn — (String)

              The Amazon Resource Name (ARN) of the Outpost.

          • SubnetStatus — (String)

            The status of the subnet.

        • DBSubnetGroupArn — (String)

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

        • SupportedNetworkTypes — (Array<String>)

          The network type of the DB subnet group.

          Valid values:

          • IPV4

          • DUAL

          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 RDS User Guide.

Returns:

  • (AWS.Request)

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

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

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

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

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

For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

Service Reference:

Examples:

Calling the createEventSubscription operation

var params = {
  SnsTopicArn: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the subscription.

      Constraints: The name must be less than 255 characters.

    • SnsTopicArn — (String)

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

      Note: RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

      Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy

    • EventCategories — (Array<String>)

      A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

    • SourceIds — (Array<String>)

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

      Constraints:

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

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

    • Enabled — (Boolean)

      Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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:

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

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

Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

Note: This operation applies only to Aurora DB clusters.

Service Reference:

Examples:

Calling the createGlobalCluster operation

var params = {
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE',
  SourceDBClusterIdentifier: 'STRING_VALUE',
  StorageEncrypted: true || false
};
rds.createGlobalCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • SourceDBClusterIdentifier — (String)

      The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

      If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

      • DatabaseName

      • Engine

      • EngineVersion

      • StorageEncrypted

    • Engine — (String)

      The database engine to use for this global database cluster.

      Valid Values: aurora-mysql | aurora-postgresql

      Constraints:

      • Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

    • EngineVersion — (String)

      The engine version to use for this global database cluster.

      Constraints:

      • Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

    • DeletionProtection — (Boolean)

      Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.

    • DatabaseName — (String)

      The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.

      Constraints:

      • Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

    • StorageEncrypted — (Boolean)

      Specifies whether to enable storage encryption for the new global database cluster.

      Constraints:

      • Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GlobalCluster — (map)

        A data type representing an Aurora global database.

        • GlobalClusterIdentifier — (String)

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

        • GlobalClusterResourceId — (String)

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

        • GlobalClusterArn — (String)

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

        • Status — (String)

          Specifies the current state of this global database cluster.

        • Engine — (String)

          The Aurora database engine used by the global database cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global database cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global database cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global database cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of primary and secondary clusters within the global database cluster.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

          • Readers — (Array<String>)

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

          • IsWriter — (Boolean)

            Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

          • GlobalWriteForwardingStatus — (String)

            The status of write forwarding for a secondary cluster in the global cluster.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
          • SynchronizationStatus — (String)

            The status of synchronization of each Aurora DB cluster in the global cluster.

            Possible values include:
            • "connected"
            • "pending-resync"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

          • Status — (String)

            The current status of the global cluster. Possible values are as follows:

            • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.

            • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

            • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

            Possible values include:
            • "pending"
            • "failing-over"
            • "cancelling"
          • FromDbClusterArn — (String)

            The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

          • ToDbClusterArn — (String)

            The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

          • IsDataLossAllowed — (Boolean)

            Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

Returns:

  • (AWS.Request)

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

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

Creates a zero-ETL integration with Amazon Redshift.

Service Reference:

Examples:

Calling the createIntegration operation

var params = {
  IntegrationName: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  TargetArn: 'STRING_VALUE', /* required */
  AdditionalEncryptionContext: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  KMSKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createIntegration(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: {})
    • SourceArn — (String)

      The Amazon Resource Name (ARN) of the database to use as the source for replication.

    • TargetArn — (String)

      The ARN of the Redshift data warehouse to use as the target for replication.

    • IntegrationName — (String)

      The name of the integration.

    • KMSKeyId — (String)

      The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.

    • AdditionalEncryptionContext — (map<String>)

      An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

      You can only include this parameter if you specify the KMSKeyId parameter.

    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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:

      • SourceArn — (String)

        The Amazon Resource Name (ARN) of the database used as the source for replication.

      • TargetArn — (String)

        The ARN of the Redshift data warehouse used as the target for replication.

      • IntegrationName — (String)

        The name of the integration.

      • IntegrationArn — (String)

        The ARN of the integration.

      • KMSKeyId — (String)

        The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.

      • AdditionalEncryptionContext — (map<String>)

        The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

      • Status — (String)

        The current status of the integration.

        Possible values include:
        • "creating"
        • "active"
        • "modifying"
        • "failed"
        • "deleting"
        • "syncing"
        • "needs_attention"
      • Tags — (Array<map>)

        A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

      • CreateTime — (Date)

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

      • Errors — (Array<map>)

        Any errors associated with the integration.

        • ErrorCoderequired — (String)

          The error code associated with the integration.

        • ErrorMessage — (String)

          A message explaining the error.

Returns:

  • (AWS.Request)

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

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

Creates a new option group. You can create up to 20 option groups.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the createOptionGroup operation

var params = {
  EngineName: 'STRING_VALUE', /* required */
  MajorEngineVersion: 'STRING_VALUE', /* required */
  OptionGroupDescription: 'STRING_VALUE', /* required */
  OptionGroupName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createOptionGroup(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: {})
    • OptionGroupName — (String)

      Specifies the name of the option group to be created.

      Constraints:

      • Must be 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: myoptiongroup

    • EngineName — (String)

      The name of the engine to associate this option group with.

      Valid Values:

      • db2-ae

      • db2-se

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • MajorEngineVersion — (String)

      Specifies the major version of the engine that this option group should be associated with.

    • OptionGroupDescription — (String)

      The description of the option group.

    • Tags — (Array<map>)

      Tags to assign to the option group.

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

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

Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.

Service Reference:

Examples:

Calling the createTenantDatabase operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  MasterUserPassword: 'STRING_VALUE', /* required */
  MasterUsername: 'STRING_VALUE', /* required */
  TenantDBName: 'STRING_VALUE', /* required */
  CharacterSetName: 'STRING_VALUE',
  NcharCharacterSetName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.createTenantDatabase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.

    • TenantDBName — (String)

      The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.

    • MasterUsername — (String)

      The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.

      Constraints:

      • Must be 1 to 16 letters, numbers, or underscores.

      • First character must be a letter.

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

    • MasterUserPassword — (String)

      The password for the master user in your tenant database.

      Constraints:

      • Must be 8 to 30 characters.

      • Can include any printable ASCII character except forward slash (/), double quote ("), at symbol (@), ampersand (&), or single quote (').

    • CharacterSetName — (String)

      The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.

    • NcharCharacterSetName — (String)

      The NCHAR value for the tenant database.

    • Tags — (Array<map>)

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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:

      • TenantDatabase — (map)

        A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

        • TenantDatabaseCreateTime — (Date)

          The creation time of the tenant database.

        • DBInstanceIdentifier — (String)

          The ID of the DB instance that contains the tenant database.

        • TenantDBName — (String)

          The database name of the tenant database.

        • Status — (String)

          The status of the tenant database.

        • MasterUsername — (String)

          The master username of the tenant database.

        • DbiResourceId — (String)

          The Amazon Web Services Region-unique, immutable identifier for the DB instance.

        • TenantDatabaseResourceId — (String)

          The Amazon Web Services Region-unique, immutable identifier for the tenant database.

        • TenantDatabaseARN — (String)

          The Amazon Resource Name (ARN) for the tenant database.

        • CharacterSetName — (String)

          The character set of the tenant database.

        • NcharCharacterSetName — (String)

          The NCHAR character set name of the tenant database.

        • DeletionProtection — (Boolean)

          Specifies whether deletion protection is enabled for the DB instance.

        • PendingModifiedValues — (map)

          Information about pending changes for a tenant database.

          • MasterUserPassword — (String)

            The master password for the tenant database.

          • TenantDBName — (String)

            The name of the tenant database.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.

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

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

Service Reference:

Examples:

Calling the deleteBlueGreenDeployment operation

var params = {
  BlueGreenDeploymentIdentifier: 'STRING_VALUE', /* required */
  DeleteTarget: true || false
};
rds.deleteBlueGreenDeployment(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: {})
    • BlueGreenDeploymentIdentifier — (String)

      The unique identifier of the blue/green deployment to delete. This parameter isn't case-sensitive.

      Constraints:

      • Must match an existing blue/green deployment identifier.

    • DeleteTarget — (Boolean)

      Specifies whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.

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.

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

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

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

  • The CEV must not be the default for RDS Custom. If it is, change the default before running this command.

  • The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.

Typically, deletion takes a few minutes.

Note: The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.

For more information, see Deleting a CEV in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteCustomDBEngineVersion operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE' /* required */
};
rds.deleteCustomDBEngineVersion(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. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.

    • EngineVersion — (String)

      The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.

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.

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

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

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

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

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

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

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DeleteAutomatedBackups: true || false,
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
rds.deleteDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

      • Must match an existing DBClusterIdentifier.

    • SkipFinalSnapshot — (Boolean)

      Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

      Note: You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
    • FinalDBSnapshotIdentifier — (String)

      The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

      Note: Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

      Constraints:

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

      • First character must be a letter

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

    • DeleteAutomatedBackups — (Boolean)

      Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBCluster — (map)

        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)

          Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB cluster.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • GlobalWriteForwardingStatus — (String)

          The status of write forwarding for a secondary cluster in an Aurora global database.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

        • PendingModifiedValues — (map)

          Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • DBClusterIdentifier — (String)

            The DBClusterIdentifier value for the DB cluster.

          • MasterUserPassword — (String)

            The master credentials for the DB cluster.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • EngineVersion — (String)

            The database engine version.

          • BackupRetentionPeriod — (Integer)

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

          • AllocatedStorage — (Integer)

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

          • 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"
          • Iops — (Integer)

            The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

          • StorageType — (String)

            The storage type for the DB cluster.

        • DBClusterInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

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

        • StorageType — (String)

          The storage type associated with the DB cluster.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value.

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

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB cluster is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.

          For more information, see CreateDBCluster.

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

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

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

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

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

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

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

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB cluster.

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

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

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

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

          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

        • ServerlessV2ScalingConfiguration — (map)

          The scaling configuration for 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 instance.

          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.

          This setting is only for Aurora DB clusters.

          Valid Values: IPV4 | DUAL

        • DBSystemId — (String)

          Reserved for future use.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

          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.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • IOOptimizedNextAllowedModificationTime — (Date)

          The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

          This setting is only for Aurora DB clusters.

        • LocalWriteForwardingStatus — (String)

          Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "requested"
        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • LimitlessDatabase — (map)

          The details for Aurora Limitless Database.

          • Status — (String)

            The status of Aurora Limitless Database.

            Possible values include:
            • "active"
            • "not-in-use"
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "modifying-max-capacity"
            • "error"
          • MinRequiredACU — (Float)

            The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).

        • StorageThroughput — (Integer)

          The storage throughput for the DB cluster. 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.

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

Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.

Service Reference:

Examples:

Calling the deleteDBClusterAutomatedBackup operation

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

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

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:

      • DBClusterAutomatedBackup — (map)

        An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.

        • Engine — (String)

          The name of the database engine for this automated backup.

        • VpcId — (String)

          The VPC ID associated with the DB cluster.

        • DBClusterAutomatedBackupsArn — (String)

          The Amazon Resource Name (ARN) for the automated backups.

        • DBClusterIdentifier — (String)

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

        • RestoreWindow — (map)

          Earliest and latest time an instance can be restored to:

          • EarliestTime — (Date)

            The earliest time you can restore an instance to.

          • LatestTime — (Date)

            The latest time you can restore an instance to.

        • MasterUsername — (String)

          The master user name of the automated backup.

        • DbClusterResourceId — (String)

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

        • Region — (String)

          The Amazon Web Services Region associated with the automated backup.

        • LicenseModel — (String)

          The license model information for this DB cluster automated backup.

        • Status — (String)

          A list of status information for an automated backup:

          • retained - Automated backups for deleted clusters.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

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

        • ClusterCreateTime — (Date)

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

        • StorageEncrypted — (Boolean)

          Indicates whether the source DB cluster is encrypted.

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

        • EngineVersion — (String)

          The version of the database engine for the automated backup.

        • DBClusterArn — (String)

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

        • BackupRetentionPeriod — (Integer)

          The retention period for the automated backups.

        • EngineMode — (String)

          The engine mode of the database engine for the automated backup.

        • AvailabilityZones — (Array<String>)

          The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

        • Port — (Integer)

          The port number that the automated backup used for connections.

          Default: Inherits from the source DB cluster

          Valid Values: 1150-65535

        • KmsKeyId — (String)

          The Amazon Web Services KMS key ID for an automated backup.

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

        • StorageType — (String)

          The storage type associated with the DB cluster.

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

        • Iops — (Integer)

          The IOPS (I/O operations per second) value for the automated backup.

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

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • StorageThroughput — (Integer)

          The storage throughput for the automated backup. 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.

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

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the deleteDBClusterEndpoint operation

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

      The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

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:

      • DBClusterEndpointIdentifier — (String)

        The identifier associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterIdentifier — (String)

        The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterEndpointResourceIdentifier — (String)

        A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

      • Endpoint — (String)

        The DNS address of the endpoint.

      • Status — (String)

        The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

      • EndpointType — (String)

        The type of the endpoint. One of: READER, WRITER, CUSTOM.

      • CustomEndpointType — (String)

        The type associated with a custom endpoint. One of: READER, WRITER, ANY.

      • StaticMembers — (Array<String>)

        List of DB instance identifiers that are part of the custom endpoint group.

      • ExcludedMembers — (Array<String>)

        List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

      • DBClusterEndpointArn — (String)

        The Amazon Resource Name (ARN) for the endpoint.

Returns:

  • (AWS.Request)

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

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

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

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the DB cluster parameter group.

      Constraints:

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

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

      • Can't be associated with any DB clusters.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

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

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

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

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

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBClusterSnapshot operation

var params = {
  DBClusterSnapshotIdentifier: 'STRING_VALUE' /* required */
};
rds.deleteDBClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier of the DB cluster snapshot to delete.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBClusterSnapshot — (map)

        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.

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

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

Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.

If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

  • The DB cluster is a read replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the DeleteDBInstance operation to delete the final instance in the DB cluster.

For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.

Service Reference:

Examples:

Calling the deleteDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  DeleteAutomatedBackups: true || false,
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
rds.deleteDBInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

      • Must match the name of an existing DB instance.

    • SkipFinalSnapshot — (Boolean)

      Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.

      Note: If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

      When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

      If you delete a read replica or an RDS Custom instance, you must enable this setting.

      This setting is required for RDS Custom.

    • FinalDBSnapshotIdentifier — (String)

      The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

      Note: If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • Must be 1 to 255 letters or numbers.

      • First character must be a letter.

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

      • Can't be specified when deleting a read replica.

    • DeleteAutomatedBackups — (Boolean)

      Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

        • DBInstanceIdentifier — (String)

          The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The database engine used for this DB instance.

        • DBInstanceStatus — (String)

          The current state of this database.

          For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB instance is restarted automatically.

        • MasterUsername — (String)

          The master username for the DB instance.

        • DBName — (String)

          The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

        • Endpoint — (map)

          The connection endpoint for the DB instance.

          Note: The endpoint might not be shown for instances with the status of creating.
          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • AllocatedStorage — (Integer)

          The amount of storage in gibibytes (GiB) allocated for the DB instance.

        • InstanceCreateTime — (Date)

          The date and time when the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

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

        • DBSecurityGroups — (Array<map>)

          A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          The list of Amazon EC2 VPC security groups that the DB instance 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.

        • DBParameterGroups — (Array<map>)

          The list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DB parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          The name of the Availability Zone where the DB instance is located.

        • DBSubnetGroup — (map)

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

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              The identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the OrderableDBInstanceOption data type.

              • Name — (String)

                The name of the Availability Zone.

            • SubnetOutpost — (map)

              If the subnet is associated with an Outpost, this value specifies the Outpost.

              For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

              • Arn — (String)

                The Amazon Resource Name (ARN) of the Outpost.

            • SubnetStatus — (String)

              The status of the subnet.

          • DBSubnetGroupArn — (String)

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

          • SupportedNetworkTypes — (Array<String>)

            The network type of the DB subnet group.

            Valid values:

            • IPV4

            • DUAL

            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 RDS User Guide.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            The name of the compute and memory capacity class for the DB instance.

          • AllocatedStorage — (Integer)

            The allocated storage size for the DB instance specified in gibibytes (GiB).

          • MasterUserPassword — (String)

            The master credentials for the DB instance.

          • Port — (Integer)

            The port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            The number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

          • EngineVersion — (String)

            The database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

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

          • Iops — (Integer)

            The Provisioned IOPS value for the DB instance.

          • DBInstanceIdentifier — (String)

            The database identifier for the DB instance.

          • StorageType — (String)

            The storage type of the DB instance.

          • CACertificateIdentifier — (String)

            The identifier of the CA certificate for the DB instance.

            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.

          • DBSubnetGroupName — (String)

            The DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • ProcessorFeatures — (Array<map>)

            The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

            • Name — (String)

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

            • Value — (String)

              The value of a processor feature name.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • AutomationMode — (String)

            The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

            Possible values include:
            • "full"
            • "all-paused"
          • ResumeFullAutomationModeTime — (Date)

            The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

          • StorageThroughput — (Integer)

            The storage throughput of the DB instance.

          • Engine — (String)

            The database engine of the DB instance.

          • DedicatedLogVolume — (Boolean)

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

          • MultiTenant — (Boolean)

            Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

        • EngineVersion — (String)

          The version of the database engine.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          The identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

          Note: Currently, each RDS DB instance can have only one Aurora read replica.
        • ReplicaMode — (String)

          The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

          Note: This attribute is only supported in RDS for Oracle.
          Possible values include:
          • "open-read-only"
          • "mounted"
        • LicenseModel — (String)

          The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value for the DB instance.

        • OptionGroupMemberships — (Array<map>)

          The list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

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

        • NcharCharacterSetName — (String)

          The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB instance is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the DB instance isn't a read replica, the value is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).

          • Status — (String)

            The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

          • Message — (String)

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

        • StorageType — (String)

          The storage type associated with the DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Indicates whether the DB instance is encrypted.

        • KmsKeyId — (String)

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

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

        • DbiResourceId — (String)

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

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

          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.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB instance.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • CopyTagsToSnapshot — (Boolean)

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

          This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          The order of priority 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.

        • DBInstanceArn — (String)

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

        • Timezone — (String)

          The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for 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 for the DB instance.

          For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB instance.

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

          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

        • EnabledCloudwatchLogsExports — (Array<String>)

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

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

        • ProcessorFeatures — (Array<map>)

          The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

          • Name — (String)

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

          • Value — (String)

            The value of a processor feature name.

        • DeletionProtection — (Boolean)

          Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

        • AssociatedRoles — (Array<map>)

          The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

          • RoleArn — (String)

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

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

          • Status — (String)

            Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

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

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

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

        • ListenerEndpoint — (map)

          The listener connection endpoint for SQL Server Always On.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

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

        • MaxAllocatedStorage — (Integer)

          The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • DBInstanceAutomatedBackupsReplications — (Array<map>)

          The list of replicated automated backups associated with the DB instance.

          • DBInstanceAutomatedBackupsArn — (String)

            The Amazon Resource Name (ARN) of the replicated automated backups.

        • CustomerOwnedIpEnabled — (Boolean)

          Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

          A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

          For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

          For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

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

        • ActivityStreamMode — (String)

          The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

          Possible values include:
          • "sync"
          • "async"
        • ActivityStreamEngineNativeAuditFieldsIncluded — (Boolean)

          Indicates whether engine-native audit fields are included in the database activity stream.

        • AutomationMode — (String)

          The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.

          Possible values include:
          • "full"
          • "all-paused"
        • ResumeFullAutomationModeTime — (Date)

          The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

        • CustomIamInstanceProfile — (String)

          The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

          • The profile must exist in your account.

          • The profile must have an IAM role that Amazon EC2 has permissions to assume.

          • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

          For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

        • BackupTarget — (String)

          The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

        • NetworkType — (String)

          The network type of the DB instance.

          The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

          Valid Values: IPV4 | DUAL

        • ActivityStreamPolicyStatus — (String)

          The status of the policy state of the activity stream.

          Possible values include:
          • "locked"
          • "unlocked"
          • "locking-policy"
          • "unlocking-policy"
        • StorageThroughput — (Integer)

          The storage throughput for the DB instance.

          This setting applies only to the gp3 storage type.

        • DBSystemId — (String)

          The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

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

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • CertificateDetails — (map)

          The details of the DB instance's server certificate.

          • CAIdentifier — (String)

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

          • ValidTill — (Date)

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

        • ReadReplicaSourceDBClusterIdentifier — (String)

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

        • PercentProgress — (String)

          The progress of the storage optimization operation as a percentage.

        • DedicatedLogVolume — (Boolean)

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

        • IsStorageConfigUpgradeAvailable — (Boolean)

          Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

        • MultiTenant — (Boolean)

          Specifies whether the DB instance is in 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.

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

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

Service Reference:

Examples:

Calling the deleteDBInstanceAutomatedBackup operation

var params = {
  DBInstanceAutomatedBackupsArn: 'STRING_VALUE',
  DbiResourceId: 'STRING_VALUE'
};
rds.deleteDBInstanceAutomatedBackup(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: {})
    • DbiResourceId — (String)

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

    • DBInstanceAutomatedBackupsArn — (String)

      The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

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:

      • DBInstanceAutomatedBackup — (map)

        An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the automated backups.

        • DbiResourceId — (String)

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

        • Region — (String)

          The Amazon Web Services Region associated with the automated backup.

        • DBInstanceIdentifier — (String)

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

        • RestoreWindow — (map)

          The earliest and latest time a DB instance can be restored to.

          • EarliestTime — (Date)

            The earliest time you can restore an instance to.

          • LatestTime — (Date)

            The latest time you can restore an instance to.

        • AllocatedStorage — (Integer)

          The allocated storage size for the the automated backup in gibibytes (GiB).

        • Status — (String)

          A list of status information for an automated backup:

          • active - Automated backups for current instances.

          • retained - Automated backups for deleted instances.

          • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • Port — (Integer)

          The port number that the automated backup used for connections.

          Default: Inherits from the source DB instance

          Valid Values: 1150-65535

        • AvailabilityZone — (String)

          The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

        • VpcId — (String)

          The VPC ID associated with the DB instance.

        • InstanceCreateTime — (Date)

          The date and time when the DB instance was created.

        • MasterUsername — (String)

          The master user name of an automated backup.

        • Engine — (String)

          The name of the database engine for this automated backup.

        • EngineVersion — (String)

          The version of the database engine for the automated backup.

        • LicenseModel — (String)

          The license model information for the automated backup.

        • Iops — (Integer)

          The IOPS (I/O operations per second) value for the automated backup.

        • OptionGroupName — (String)

          The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the automated backup is associated for TDE encryption.

        • Encrypted — (Boolean)

          Indicates whether the automated backup is encrypted.

        • StorageType — (String)

          The storage type associated with the automated backup.

        • KmsKeyId — (String)

          The Amazon Web Services KMS key ID for an automated backup.

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

        • Timezone — (String)

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

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • BackupRetentionPeriod — (Integer)

          The retention period for the automated backups.

        • DBInstanceAutomatedBackupsArn — (String)

          The Amazon Resource Name (ARN) for the replicated automated backups.

        • DBInstanceAutomatedBackupsReplications — (Array<map>)

          The list of replications to different Amazon Web Services Regions associated with the automated backup.

          • DBInstanceAutomatedBackupsArn — (String)

            The Amazon Resource Name (ARN) of the replicated automated backups.

        • BackupTarget — (String)

          The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

        • StorageThroughput — (Integer)

          The storage throughput for the automated backup.

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • DedicatedLogVolume — (Boolean)

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

        • MultiTenant — (Boolean)

          Specifies whether the automatic backup is for a DB instance in 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.

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

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

Service Reference:

Examples:

Calling the deleteDBParameterGroup operation

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

      The name of the DB parameter group.

      Constraints:

      • Must be the name of an existing DB parameter group

      • You can't delete a default DB parameter group

      • Can't be associated with any DB instances

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.

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

Deletes an existing DB proxy.

Service Reference:

Examples:

Calling the deleteDBProxy operation

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

      The name of the DB proxy to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBProxy — (map)

        The data structure representing the details of the DB proxy that you delete.

        • DBProxyName — (String)

          The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

        • DBProxyArn — (String)

          The Amazon Resource Name (ARN) for the proxy.

        • Status — (String)

          The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.

          Possible values include:
          • "available"
          • "modifying"
          • "incompatible-network"
          • "insufficient-resource-limits"
          • "creating"
          • "deleting"
          • "suspended"
          • "suspending"
          • "reactivating"
        • EngineFamily — (String)

          The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. SQLSERVER supports RDS for Microsoft SQL Server databases.

        • VpcId — (String)

          Provides the VPC ID of the DB proxy.

        • VpcSecurityGroupIds — (Array<String>)

          Provides a list of VPC security groups that the proxy belongs to.

        • VpcSubnetIds — (Array<String>)

          The EC2 subnet IDs for the proxy.

        • Auth — (Array<map>)

          One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.

          • Description — (String)

            A user-specified description about the authentication used by a proxy to log in as a specific database user.

          • UserName — (String)

            The name of the database user to which the proxy connects.

          • AuthScheme — (String)

            The type of authentication that the proxy uses for connections from the proxy to the underlying database.

            Possible values include:
            • "SECRETS"
          • SecretArn — (String)

            The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

          • IAMAuth — (String)

            Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
            • "ENABLED"
          • ClientPasswordAuthType — (String)

            The type of authentication the proxy uses for connections from clients.

            Possible values include:
            • "MYSQL_NATIVE_PASSWORD"
            • "POSTGRES_SCRAM_SHA_256"
            • "POSTGRES_MD5"
            • "SQL_SERVER_AUTHENTICATION"
        • RoleArn — (String)

          The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

        • Endpoint — (String)

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

        • RequireTLS — (Boolean)

          Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

        • IdleClientTimeout — (Integer)

          The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.

          Default: 1800 (30 minutes)

          Constraints: 1 to 28,800

        • DebugLogging — (Boolean)

          Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.

        • CreatedDate — (Date)

          The date and time when the proxy was first created.

        • UpdatedDate — (Date)

          The date and time when the proxy was last updated.

Returns:

  • (AWS.Request)

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

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

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

Service Reference:

Examples:

Calling the deleteDBProxyEndpoint operation

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

      The name of the DB proxy endpoint to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBProxyEndpoint — (map)

        The data structure representing the details of the DB proxy endpoint that you delete.

        • DBProxyEndpointName — (String)

          The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

        • DBProxyEndpointArn — (String)

          The Amazon Resource Name (ARN) for the DB proxy endpoint.

        • DBProxyName — (String)

          The identifier for the DB proxy that is associated with this DB proxy endpoint.

        • Status — (String)

          The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.

          Possible values include:
          • "available"
          • "modifying"
          • "incompatible-network"
          • "insufficient-resource-limits"
          • "creating"
          • "deleting"
        • VpcId — (String)

          Provides the VPC ID of the DB proxy endpoint.

        • VpcSecurityGroupIds — (Array<String>)

          Provides a list of VPC security groups that the DB proxy endpoint belongs to.

        • VpcSubnetIds — (Array<String>)

          The EC2 subnet IDs for the DB proxy endpoint.

        • Endpoint — (String)

          The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.

        • CreatedDate — (Date)

          The date and time when the DB proxy endpoint was first created.

        • TargetRole — (String)

          A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

          Possible values include:
          • "READ_WRITE"
          • "READ_ONLY"
        • IsDefault — (Boolean)

          Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.

Returns:

  • (AWS.Request)

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

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

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

Note: EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBSecurityGroup operation

var params = {
  DBSecurityGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBSecurityGroup(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 delete.

      Note: You can't delete the default DB security group.

      Constraints:

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

      • First character must be a letter

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

      • Must not be "Default"

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.

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

Deletes an Aurora Limitless Database DB shard group.

Service Reference:

Examples:

Calling the deleteDBShardGroup operation

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

      Teh name of the DB shard group to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBShardGroupResourceId — (String)

        The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

      • DBShardGroupIdentifier — (String)

        The name of the DB shard group.

      • DBClusterIdentifier — (String)

        The name of the primary DB cluster for the DB shard group.

      • MaxACU — (Float)

        The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      • ComputeRedundancy — (Integer)

        Specifies whether to create standby instances for the DB shard group. Valid values are the following:

        • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

        • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

        • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

      • Status — (String)

        The status of the DB shard group.

      • PubliclyAccessible — (Boolean)

        Indicates whether the DB shard group is publicly accessible.

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

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

        For more information, see CreateDBShardGroup.

        This setting is only for Aurora Limitless Database.

      • Endpoint — (String)

        The connection endpoint for the DB shard group.

Returns:

  • (AWS.Request)

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

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

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

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

Service Reference:

Examples:

Calling the deleteDBSnapshot operation

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

      The DB snapshot identifier.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

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

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

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

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

Deletes a DB subnet group.

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

Service Reference:

Examples:

Calling the deleteDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the database subnet group to delete.

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

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

      Example: mydbsubnetgroup

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

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

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

Deletes an RDS event notification subscription.

Service Reference:

Examples:

Calling the deleteEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE' /* required */
};
rds.deleteEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the RDS event notification subscription you want to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • EventSubscription — (map)

        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.

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

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the deleteGlobalCluster operation

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE' /* required */
};
rds.deleteGlobalCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The cluster identifier of the global database cluster being deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • GlobalCluster — (map)

        A data type representing an Aurora global database.

        • GlobalClusterIdentifier — (String)

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

        • GlobalClusterResourceId — (String)

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

        • GlobalClusterArn — (String)

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

        • Status — (String)

          Specifies the current state of this global database cluster.

        • Engine — (String)

          The Aurora database engine used by the global database cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • DatabaseName — (String)

          The default database name within the new global database cluster.

        • StorageEncrypted — (Boolean)

          The storage encryption setting for the global database cluster.

        • DeletionProtection — (Boolean)

          The deletion protection setting for the new global database cluster.

        • GlobalClusterMembers — (Array<map>)

          The list of primary and secondary clusters within the global database cluster.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

          • Readers — (Array<String>)

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

          • IsWriter — (Boolean)

            Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

          • GlobalWriteForwardingStatus — (String)

            The status of write forwarding for a secondary cluster in the global cluster.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
          • SynchronizationStatus — (String)

            The status of synchronization of each Aurora DB cluster in the global cluster.

            Possible values include:
            • "connected"
            • "pending-resync"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

          • Status — (String)

            The current status of the global cluster. Possible values are as follows:

            • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.

            • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

            • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

            Possible values include:
            • "pending"
            • "failing-over"
            • "cancelling"
          • FromDbClusterArn — (String)

            The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

          • ToDbClusterArn — (String)

            The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

          • IsDataLossAllowed — (Boolean)

            Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

Returns:

  • (AWS.Request)

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

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

Deletes a zero-ETL integration with Amazon Redshift.

Service Reference:

Examples:

Calling the deleteIntegration operation

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

      The unique identifier of the integration.

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:

      • SourceArn — (String)

        The Amazon Resource Name (ARN) of the database used as the source for replication.

      • TargetArn — (String)

        The ARN of the Redshift data warehouse used as the target for replication.

      • IntegrationName — (String)

        The name of the integration.

      • IntegrationArn — (String)

        The ARN of the integration.

      • KMSKeyId — (String)

        The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.

      • AdditionalEncryptionContext — (map<String>)

        The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

      • Status — (String)

        The current status of the integration.

        Possible values include:
        • "creating"
        • "active"
        • "modifying"
        • "failed"
        • "deleting"
        • "syncing"
        • "needs_attention"
      • Tags — (Array<map>)

        A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

      • CreateTime — (Date)

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

      • Errors — (Array<map>)

        Any errors associated with the integration.

        • ErrorCoderequired — (String)

          The error code associated with the integration.

        • ErrorMessage — (String)

          A message explaining the error.

Returns:

  • (AWS.Request)

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

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

Deletes an existing option group.

Service Reference:

Examples:

Calling the deleteOptionGroup operation

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

      The name of the option group to be deleted.

      Note: You can't delete default option groups.

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.

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

Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances.

You can't delete a tenant database when it is the only tenant in the DB instance.

Service Reference:

Examples:

Calling the deleteTenantDatabase operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  TenantDBName: 'STRING_VALUE', /* required */
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
rds.deleteTenantDatabase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The user-supplied identifier for the DB instance that contains the tenant database that you want to delete.

    • TenantDBName — (String)

      The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive.

    • SkipFinalSnapshot — (Boolean)

      Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

    • FinalDBSnapshotIdentifier — (String)

      The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

      Note: If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

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:

      • TenantDatabase — (map)

        A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

        • TenantDatabaseCreateTime — (Date)

          The creation time of the tenant database.

        • DBInstanceIdentifier — (String)

          The ID of the DB instance that contains the tenant database.

        • TenantDBName — (String)

          The database name of the tenant database.

        • Status — (String)

          The status of the tenant database.

        • MasterUsername — (String)

          The master username of the tenant database.

        • DbiResourceId — (String)

          The Amazon Web Services Region-unique, immutable identifier for the DB instance.

        • TenantDatabaseResourceId — (String)

          The Amazon Web Services Region-unique, immutable identifier for the tenant database.

        • TenantDatabaseARN — (String)

          The Amazon Resource Name (ARN) for the tenant database.

        • CharacterSetName — (String)

          The character set of the tenant database.

        • NcharCharacterSetName — (String)

          The NCHAR character set name of the tenant database.

        • DeletionProtection — (Boolean)

          Specifies whether deletion protection is enabled for the DB instance.

        • PendingModifiedValues — (map)

          Information about pending changes for a tenant database.

          • MasterUserPassword — (String)

            The master password for the tenant database.

          • TenantDBName — (String)

            The name of the tenant database.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.

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

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

Service Reference:

Examples:

Calling the deregisterDBProxyTargets operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  DBClusterIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  DBInstanceIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  TargetGroupName: 'STRING_VALUE'
};
rds.deregisterDBProxyTargets(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: {})
    • DBProxyName — (String)

      The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

    • TargetGroupName — (String)

      The identifier of the DBProxyTargetGroup.

    • DBInstanceIdentifiers — (Array<String>)

      One or more DB instance identifiers.

    • DBClusterIdentifiers — (Array<String>)

      One or more DB cluster identifiers.

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.

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

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command doesn't take any parameters.

Service Reference:

Examples:

Calling the describeAccountAttributes operation

var params = {
};
rds.describeAccountAttributes(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: {})

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:

      • AccountQuotas — (Array<map>)

        A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

        • AccountQuotaName — (String)

          The name of the Amazon RDS quota for this Amazon Web Services account.

        • Used — (Integer)

          The amount currently used toward the quota maximum.

        • Max — (Integer)

          The maximum allowed value for the quota.

Returns:

  • (AWS.Request)

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

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

Describes one or more blue/green deployments.

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.

Service Reference:

Examples:

Calling the describeBlueGreenDeployments operation

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

      The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.

      Constraints:

      • Must match an existing blue/green deployment identifier.

    • Filters — (Array<map>)

      A filter that specifies one or more blue/green deployments to describe.

      Valid Values:

      • blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.

      • blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.

      • source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.

      • target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints:

      • Must be a minimum of 20.

      • Can't exceed 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • BlueGreenDeployments — (Array<map>)

        A list of blue/green deployments in the current account and Amazon Web Services Region.

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

          • 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}.:/=+\-@]*)$").

      • Marker — (String)

        A pagination token that can be used in a later DescribeBlueGreenDeployments request.

Returns:

  • (AWS.Request)

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

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

Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.

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.

Service Reference:

Examples:

Calling the describeCertificates operation

var params = {
  CertificateIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeCertificates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

      Constraints:

      • Must match an existing CertificateIdentifier.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DefaultCertificateForNewLaunches — (String)

        The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the ModifyCertificates operation.

      • Certificates — (Array<map>)

        The list of Certificate objects for the Amazon Web Services account.

        • CertificateIdentifier — (String)

          The unique key that identifies a certificate.

        • CertificateType — (String)

          The type of the certificate.

        • Thumbprint — (String)

          The thumbprint of the certificate.

        • ValidFrom — (Date)

          The starting date from which the certificate is valid.

        • ValidTill — (Date)

          The final date that the certificate continues to be valid.

        • CertificateArn — (String)

          The Amazon Resource Name (ARN) for the certificate.

        • CustomerOverride — (Boolean)

          Indicates whether there is an override for the default certificate identifier.

        • CustomerOverrideValidTill — (Date)

          If there is an override for the default certificate identifier, when the override expires.

      • Marker — (String)

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

Returns:

  • (AWS.Request)

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

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

Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

All parameters are optional.

Examples:

Calling the describeDBClusterAutomatedBackups operation

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

      The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

    • DBClusterIdentifier — (String)

      (Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.

    • Filters — (Array<map>)

      A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • retained - Automated backups for deleted clusters and after backup replication is stopped.

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

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

      Returns all resources by default. The status for each resource is specified in the response.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

    • Marker — (String)

      The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

        The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

      • DBClusterAutomatedBackups — (Array<map>)

        A list of DBClusterAutomatedBackup backups.

        • Engine — (String)

          The name of the database engine for this automated backup.

        • VpcId — (String)

          The VPC ID associated with the DB cluster.

        • DBClusterAutomatedBackupsArn — (String)

          The Amazon Resource Name (ARN) for the automated backups.

        • DBClusterIdentifier — (String)

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

        • RestoreWindow — (map)

          Earliest and latest time an instance can be restored to:

          • EarliestTime — (Date)

            The earliest time you can restore an instance to.

          • LatestTime — (Date)

            The latest time you can restore an instance to.

        • MasterUsername — (String)

          The master user name of the automated backup.

        • DbClusterResourceId — (String)

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

        • Region — (String)

          The Amazon Web Services Region associated with the automated backup.

        • LicenseModel — (String)

          The license model information for this DB cluster automated backup.

        • Status — (String)

          A list of status information for an automated backup:

          • retained - Automated backups for deleted clusters.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

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

        • ClusterCreateTime — (Date)

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

        • StorageEncrypted — (Boolean)

          Indicates whether the source DB cluster is encrypted.

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

        • EngineVersion — (String)

          The version of the database engine for the automated backup.

        • DBClusterArn — (String)

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

        • BackupRetentionPeriod — (Integer)

          The retention period for the automated backups.

        • EngineMode — (String)

          The engine mode of the database engine for the automated backup.

        • AvailabilityZones — (Array<String>)

          The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

        • Port — (Integer)

          The port number that the automated backup used for connections.

          Default: Inherits from the source DB cluster

          Valid Values: 1150-65535

        • KmsKeyId — (String)

          The Amazon Web Services KMS key ID for an automated backup.

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

        • StorageType — (String)

          The storage type associated with the DB cluster.

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

        • Iops — (Integer)

          The IOPS (I/O operations per second) value for the automated backup.

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

        • AwsBackupRecoveryPointArn — (String)

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • StorageThroughput — (Integer)

          The storage throughput for the automated backup. 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.

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

Returns information about backtracks for a DB cluster.

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

Note: This action only applies to Aurora MySQL DB clusters.

Service Reference:

Examples:

Calling the describeDBClusterBacktracks operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  BacktrackIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBClusterBacktracks(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 described. 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

    • BacktrackIdentifier — (String)

      If specified, this value is the backtrack identifier of the backtrack to be described.

      Constraints:

      Example: 123e4567-e89b-12d3-a456-426655440000

    • Filters — (Array<map>)

      A filter that specifies one or more DB clusters to describe. Supported filters include the following:

      • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

      • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

        • applying

        • completed

        • failed

        • pending

        The results list includes information about only the backtracks identified by these values.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

        A pagination token that can be used in a later DescribeDBClusterBacktracks request.

      • DBClusterBacktracks — (Array<map>)

        Contains a list of backtracks for the user.

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

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

Returns information about endpoints for an Amazon Aurora DB cluster.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the describeDBClusterEndpoints operation

var params = {
  DBClusterEndpointIdentifier: 'STRING_VALUE',
  DBClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBClusterEndpoints(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 associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterEndpointIdentifier — (String)

      The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

    • Filters — (Array<map>)

      A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

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

      • DBClusterEndpoints — (Array<map>)

        Contains the details of the endpoints associated with the cluster and matching any filter conditions.

        • DBClusterEndpointIdentifier — (String)

          The identifier associated with the endpoint. This parameter is stored as a lowercase string.

        • DBClusterIdentifier — (String)

          The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

        • DBClusterEndpointResourceIdentifier — (String)

          A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

        • Endpoint — (String)

          The DNS address of the endpoint.

        • Status — (String)

          The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

        • EndpointType — (String)

          The type of the endpoint. One of: READER, WRITER, CUSTOM.

        • CustomEndpointType — (String)

          The type associated with a custom endpoint. One of: READER, WRITER, ANY.

        • StaticMembers — (Array<String>)

          List of DB instance identifiers that are part of the custom endpoint group.

        • ExcludedMembers — (Array<String>)

          List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

        • DBClusterEndpointArn — (String)

          The Amazon Resource Name (ARN) for the endpoint.

Returns:

  • (AWS.Request)

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

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

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

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Examples:

Calling the describeDBClusterParameterGroups operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBClusterParameterGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

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

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

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

      • DBClusterParameterGroups — (Array<map>)

        A list of DB cluster parameter groups.

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

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

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

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

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the describeDBClusterParameters operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
rds.describeDBClusterParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

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

    • Source — (String)

      A specific source to return parameters for.

      Valid Values:

      • customer

      • engine

      • service

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Parameters — (Array<map>)

        Provides a list of parameters for the DB cluster parameter group.

        • ParameterName — (String)

          The name of the parameter.

        • ParameterValue — (String)

          The value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          The source of the parameter value.

        • ApplyType — (String)

          Specifies the engine specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

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

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
        • SupportedEngineModes — (Array<String>)

          The valid DB engine modes.

      • Marker — (String)

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

Returns:

  • (AWS.Request)

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

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

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

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 DB cluster deployments in the Amazon RDS User Guide.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Service Reference:

Examples:

Calling the describeDBClusters operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DB cluster identifier.

    • Filters — (Array<map>)

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

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

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

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      • Namerequired — (String)

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

      • Valuesrequired — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100

    • Marker — (String)

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

    • IncludeShared — (Boolean)

      Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

        A pagination token that can be used in a later DescribeDBClusters request.

      • DBClusters — (Array<map>)

        Contains a list of DB clusters for the user.

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

          Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

        • DomainMemberships — (Array<map>)

          The Active Directory Domain membership records associated with the DB cluster.

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

          • FQDN — (String)

            The fully qualified domain name (FQDN) of the Active Directory Domain.

          • IAMRoleName — (String)

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

          • OU — (String)

            The Active Directory organizational unit for the DB instance or cluster.

          • AuthSecretArn — (String)

            The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

          • DnsIps — (Array<String>)

            The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

        • TagList — (Array<map>)

          A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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}.:/=+\-@]*)$").

        • GlobalWriteForwardingStatus — (String)

          The status of write forwarding for a secondary cluster in an Aurora global database.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

        • PendingModifiedValues — (map)

          Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

          • PendingCloudwatchLogsExports — (map)

            A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

            • LogTypesToEnable — (Array<String>)

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

            • LogTypesToDisable — (Array<String>)

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

          • DBClusterIdentifier — (String)

            The DBClusterIdentifier value for the DB cluster.

          • MasterUserPassword — (String)

            The master credentials for the DB cluster.

          • IAMDatabaseAuthenticationEnabled — (Boolean)

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

          • EngineVersion — (String)

            The database engine version.

          • BackupRetentionPeriod — (Integer)

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

          • AllocatedStorage — (Integer)

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

          • 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"
          • Iops — (Integer)

            The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

          • StorageType — (String)

            The storage type for the DB cluster.

        • DBClusterInstanceClass — (String)

          The name of the compute and memory capacity class of the DB instance.

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

        • StorageType — (String)

          The storage type associated with the DB cluster.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value.

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

        • PubliclyAccessible — (Boolean)

          Indicates whether the DB cluster is publicly accessible.

          When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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.

          For more information, see CreateDBCluster.

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

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates whether minor version patches are applied automatically.

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

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

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

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

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

        • PerformanceInsightsEnabled — (Boolean)

          Indicates whether Performance Insights is enabled for the DB cluster.

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

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

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

        • PerformanceInsightsRetentionPeriod — (Integer)

          The number of days to retain Performance Insights data.

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

          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

        • ServerlessV2ScalingConfiguration — (map)

          The scaling configuration for 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 instance.

          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.

          This setting is only for Aurora DB clusters.

          Valid Values: IPV4 | DUAL

        • DBSystemId — (String)

          Reserved for future use.

        • MasterUserSecret — (map)

          The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

          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.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the secret.

          • SecretStatus — (String)

            The status of the secret.

            The possible status values include the following:

            • creating - The secret is being created.

            • active - The secret is available for normal use and rotation.

            • rotating - The secret is being rotated.

            • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

              When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

          • KmsKeyId — (String)

            The Amazon Web Services KMS key identifier that is used to encrypt the secret.

        • IOOptimizedNextAllowedModificationTime — (Date)

          The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

          This setting is only for Aurora DB cluster