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, 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

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

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.

Service Reference:

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.

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)

          A Boolean value indicating if 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).

Note: 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.

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)

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

          • CIDRIP — (String)

            Specifies 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 only applies 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)

      A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

    • UseEarliestTimeOnPointInTimeUnavailable — (Boolean)

      A value that indicates 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 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 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 export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

      • SourceArn — (String)

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

      • ExportOnly — (Array<String>)

        The data exported from the snapshot. Valid values are the following:

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

        • database.table table-name - Export a table of the snapshot. 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. 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 that the snapshot was created.

      • TaskStartTime — (Date)

        The time that the snapshot export task started.

      • TaskEndTime — (Date)

        The time that the snapshot export task completed.

      • S3Bucket — (String)

        The Amazon S3 bucket that the snapshot is exported to.

      • S3Prefix — (String)

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

      • IamRoleArn — (String)

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

      • KmsKeyId — (String)

        The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

      • Status — (String)

        The progress status of the export task.

      • PercentProgress — (Integer)

        The progress of the snapshot 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 export task.

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: This action only applies to Aurora DB clusters.

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

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed 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 pre-signed URL that is a valid request for the operation that can be executed in the source 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 pre-signed 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 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

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)

      The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

      The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

      • KmsKeyId - The Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed 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 pre-signed URL that is a valid request for the operation that can be executed 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)

      A value that indicates 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>)

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

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

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

        • SnapshotCreateTime — (Date)

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

        • Engine — (String)

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

        • EngineMode — (String)

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

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

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

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

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

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

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

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

        • StorageEncrypted — (Boolean)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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

Copies the specified DB parameter group.

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 action 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 */
  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, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

      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)

      A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy.

      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 CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. 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 action 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 action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action 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 Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action 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 pre-signed URL that is a valid request for the operation that can be executed 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.

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

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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)

            Indicate if this option is persistent.

          • Permanent — (Boolean)

            Indicate if 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)

              A Boolean value that, when true, indicates the option setting can be modified from the default.

            • IsCollection — (Boolean)

              Indicates if 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 status of the VPC security group.

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

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

Returns:

  • (AWS.Request) —

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

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

Creates a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Service Reference:

Examples:

Calling the createCustomAvailabilityZone operation

var params = {
  CustomAvailabilityZoneName: 'STRING_VALUE', /* required */
  ExistingVpnId: 'STRING_VALUE',
  NewVpnTunnelName: 'STRING_VALUE',
  VpnTunnelOriginatorIP: 'STRING_VALUE'
};
rds.createCustomAvailabilityZone(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: {}) —
    • CustomAvailabilityZoneName — (String)

      The name of the custom Availability Zone (AZ).

    • ExistingVpnId — (String)

      The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.

    • NewVpnTunnelName — (String)

      The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

      Specify this parameter only if ExistingVpnId isn't specified.

    • VpnTunnelOriginatorIP — (String)

      The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

      Specify this parameter only if ExistingVpnId isn't specified.

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:

      • CustomAvailabilityZone — (map)

        A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

        For more information about RDS on VMware, see the RDS on VMware User Guide.

        • CustomAvailabilityZoneId — (String)

          The identifier of the custom AZ.

          Amazon RDS generates a unique identifier when a custom AZ is created.

        • CustomAvailabilityZoneName — (String)

          The name of the custom AZ.

        • CustomAvailabilityZoneStatus — (String)

          The status of the custom AZ.

        • VpnDetails — (map)

          Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

          • VpnId — (String)

            The ID of the VPN.

          • VpnTunnelOriginatorIP — (String)

            The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

          • VpnGatewayIp — (String)

            The IP address of network traffic from Amazon Web Services to your on-premises data center.

          • VpnPSK — (String)

            The preshared key (PSK) for the VPN.

          • VpnName — (String)

            The name of the VPN.

          • VpnState — (String)

            The state of the VPN.

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). A CEV is a binary volume snapshot of a database engine and specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR. For more information, see Amazon RDS Custom requirements and limitations in the Amazon RDS User Guide.

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. For more information, see Preparing to create a CEV in the Amazon RDS User Guide.

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files.

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.

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 CreateCustomDbEngineVersion 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 CreateCustomDbEngineVersion event.

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

Service Reference:

Examples:

Calling the createCustomDBEngineVersion operation

var params = {
  DatabaseInstallationFilesS3BucketName: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  KMSKeyId: 'STRING_VALUE', /* required */
  Manifest: 'STRING_VALUE', /* required */
  DatabaseInstallationFilesS3Prefix: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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 name is 19.my_cev1. This setting is required for RDS Custom, 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.

    • KMSKeyId — (String)

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

      If you have an existing symmetric 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 KMS key in your account, follow the instructions in Creating symmetric KMS keys in the Amazon Web Services Key Management Service Developer Guide.

      You can choose the same symmetric 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}.:/=+\-@]*)$").

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.

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

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

        • IsMajorVersionUpgrade — (Boolean)

          A value that indicates whether 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)

          A value that indicates whether you can use Aurora parallel query with the target engine version.

        • SupportsGlobalDatabases — (Boolean)

          A value that indicates whether you can use Aurora global databases with the target engine version.

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

        A value that 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)

        A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

      • SupportsGlobalDatabases — (Boolean)

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

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.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

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

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the createDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BacktrackWindow: 'NUMBER_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: '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,
  EngineMode: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ReplicationSourceIdentifier: 'STRING_VALUE',
  ScalingConfiguration: {
    AutoPause: true || false,
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE',
    SecondsBeforeTimeout: 'NUMBER_VALUE',
    SecondsUntilAutoPause: 'NUMBER_VALUE',
    TimeoutAction: 'STRING_VALUE'
  },
  SourceRegion: 'STRING_VALUE',
  StorageEncrypted: true || false,
  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 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.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • CharacterSetName — (String)

      A value that indicates that the DB cluster should be associated with the specified CharacterSet.

    • DatabaseName — (String)

      The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

    • DBClusterIdentifier — (String)

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

    • DBClusterParameterGroupName — (String)

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

      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.

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB cluster.

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

      Example: mySubnetgroup

    • Engine — (String)

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

      Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

    • EngineVersion — (String)

      The version number of the database engine to use.

      To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

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

      To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

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

      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"

      Aurora MySQL

      Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

      Aurora PostgreSQL

      Example: 9.6.3, 10.7

    • Port — (Integer)

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

      Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

    • MasterUsername — (String)

      The name of the master user for the DB cluster.

      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. This password can contain any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • OptionGroupName — (String)

      A value that indicates that the DB cluster should be associated with the specified option group.

      Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    • 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. 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, in Universal Coordinated Time (UTC).

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

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

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

    • Tags — (Array<map>)

      Tags to assign to the DB cluster.

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

      A value that indicates whether the DB cluster is encrypted.

    • 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 will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.

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

    • PreSignedUrl — (String)

      A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

      The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

      The pre-signed URL request must contain the following parameter values:

      • KmsKeyId - The Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed 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 pre-signed URL that is a valid request for the operation that can be executed 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.
    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

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

    • BacktrackWindow — (Integer)

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

      Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters.

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

      Aurora MySQL

      Possible values are audit, error, general, and slowquery.

      Aurora PostgreSQL

      Possible value is postgresql.

    • EngineMode — (String)

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

      The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

      The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

      The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

      For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

      Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

    • ScalingConfiguration — (map)

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

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

        A value that 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 from finding a scaling point might be dropped.

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

      • SecondsBeforeTimeout — (Integer)

        The amount of time, in seconds, that Aurora Serverless 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • GlobalClusterIdentifier — (String)

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

    • EnableHttpEndpoint — (Boolean)

      A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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

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

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

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

    • DomainIAMRoleName — (String)

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

    • EnableGlobalWriteForwarding — (Boolean)

      A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.

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

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

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

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

        • BackupRetentionPeriod — (Integer)

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

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

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

        • DBClusterParameterGroup — (String)

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

        • DBSubnetGroup — (String)

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

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

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

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

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

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

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

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

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

          • DBInstanceIdentifier — (String)

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

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

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

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

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

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

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

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

        • CloneGroupId — (String)

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

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

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

        • EngineMode — (String)

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

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

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

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

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

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

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

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

          For more information, see Using the Data API for Aurora Serverless 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)

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

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

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

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

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 only applies 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. Only relevant 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 DB cluster, you need to reboot the DB instances in 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 action 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.

Note: This action only applies to Aurora DB clusters.

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 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: aurora5.6, aurora-mysql5.7

      Aurora PostgreSQL

      Example: aurora-postgresql9.6

      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 (for MySQL 5.6-compatible Aurora)

      • aurora-mysql (for MySQL 5.7-compatible Aurora)

      • aurora-postgresql

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

Note: This action only applies to Aurora DB clusters.

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

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

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

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

        • SnapshotCreateTime — (Date)

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

        • Engine — (String)

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

        • EngineMode — (String)

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

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

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

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

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

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

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

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

        • StorageEncrypted — (Boolean)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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

Creates a new DB instance.

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',
  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',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: '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',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  NcharCharacterSetName: '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,
  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.

      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

      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

      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

      Oracle

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

      Default: ORCL

      Constraints:

      • Can't be longer than 8 characters

      Amazon RDS Custom

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

      Default: ORCL

      Constraints:

      • It must contain 1 to 8 alphanumeric characters.

      • It must contain a letter.

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

      SQL Server

      Not applicable. Must be null.

      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:

      • It must contain 1 to 64 alphanumeric characters.

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

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

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

    • DBInstanceIdentifier — (String)

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

      Type: Integer

      Amazon Aurora

      Not applicable. 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): Must be an integer from 40 to 65536.

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

      MySQL

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

      • General Purpose (SSD) storage (gp2): 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.

      MariaDB

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

      • General Purpose (SSD) storage (gp2): 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.

      PostgreSQL

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

      • General Purpose (SSD) storage (gp2): 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.

      Oracle

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

      • General Purpose (SSD) storage (gp2): 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.

      SQL Server

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

      • General Purpose (SSD) storage (gp2):

        • Enterprise and Standard editions: Must be an integer from 200 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 200 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 200 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.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.

    • Engine — (String)

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

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

      Valid Values:

      • aurora (for MySQL 5.6-compatible Aurora)

      • aurora-mysql (for MySQL 5.7-compatible Aurora)

      • aurora-postgresql

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

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

      Amazon Aurora

      Not applicable. The name for the master user is managed by the DB cluster.

      MariaDB

      Constraints:

      • Required for MariaDB.

      • Must be 1 to 16 letters or numbers.

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

      Microsoft SQL Server

      Constraints:

      • Required for SQL Server.

      • Must be 1 to 128 letters or numbers.

      • The first character must be a letter.

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

      MySQL

      Constraints:

      • Required for MySQL.

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

      Oracle

      Constraints:

      • Required for Oracle.

      • Must be 1 to 30 letters or numbers.

      • First character must be a letter.

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

      PostgreSQL

      Constraints:

      • Required for PostgreSQL.

      • Must be 1 to 63 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 user. The password can include any printable ASCII character except "/", """, or "@".

      Amazon Aurora

      Not applicable. The password for the master user is managed by the DB cluster.

      MariaDB

      Constraints: Must contain from 8 to 41 characters.

      Microsoft SQL Server

      Constraints: Must contain from 8 to 128 characters.

      MySQL

      Constraints: Must contain from 8 to 41 characters.

      Oracle

      Constraints: Must contain from 8 to 30 characters.

      PostgreSQL

      Constraints: Must contain from 8 to 128 characters.

    • DBSecurityGroups — (Array<String>)

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

      Default: The default DB security group for the database engine.

    • VpcSecurityGroupIds — (Array<String>)

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

      Amazon Aurora

      Not applicable. 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.

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

      Example: us-east-1d

      Constraint: 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.

      Note: If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. For more information about RDS on VMware, see the RDS on VMware User Guide.
    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB instance.

      If there is no DB subnet group, then it is a non-VPC DB instance.

    • PreferredMaintenanceWindow — (String)

      The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

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

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • DBParameterGroupName — (String)

      The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

      This setting doesn't apply to 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

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

      Amazon Aurora

      Not applicable. 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 or 35 for an RDS Custom 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.

      Amazon Aurora

      Not applicable. 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.

      MySQL

      Default: 3306

      Valid values: 1150-65535

      Type: Integer

      MariaDB

      Default: 3306

      Valid values: 1150-65535

      Type: Integer

      PostgreSQL

      Default: 5432

      Valid values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid values: 1150-65535

      SQL Server

      Default: 1433

      Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

      Amazon Aurora

      Default: 3306

      Valid values: 1150-65535

      Type: Integer

    • MultiAZ — (Boolean)

      A value that indicates 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 RDS Custom.

    • EngineVersion — (String)

      The version number of the database engine to use.

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

      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 Aurora

      Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

      Amazon RDS Custom

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

      MariaDB

      See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

      Microsoft SQL Server

      See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

      MySQL

      See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

      Oracle

      See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

      PostgreSQL

      See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates 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)

      License model information for this DB instance.

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

      This setting doesn't apply to RDS Custom.

    • Iops — (Integer)

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

      Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

    • OptionGroupName — (String)

      A value that indicates that the DB instance should be associated with the specified option group.

      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 RDS Custom.

    • CharacterSetName — (String)

      For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.

      This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.

      Amazon Aurora

      Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

    • NcharCharacterSetName — (String)

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

      This parameter doesn't apply to RDS Custom.

    • PubliclyAccessible — (Boolean)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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 the instance will belong to.

      This setting doesn't apply to RDS Custom.

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

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

      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 RDS Custom.

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

    • StorageEncrypted — (Boolean)

      A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

      For RDS Custom Oracle instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.

      Amazon Aurora

      Not applicable. 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.

      Amazon Aurora

      Not applicable. 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.

      Amazon RDS Custom

      A KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle 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, 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.

    • CopyTagsToSnapshot — (Boolean)

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

      Amazon Aurora

      Not applicable. 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. 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.

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

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

    • DomainIAMRoleName — (String)

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

      This setting doesn't apply to RDS Custom.

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

      This setting doesn't apply to RDS Custom.

      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)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

      For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    • EnablePerformanceInsights — (Boolean)

      A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

      This setting doesn't apply to RDS Custom.

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

    • PerformanceInsightsRetentionPeriod — (Integer)

      The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      This setting doesn't apply to RDS Custom.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

      Amazon Aurora

      Not applicable. CloudWatch Logs exports are managed by the DB cluster.

      RDS Custom

      Not applicable.

      MariaDB

      Possible values are audit, error, general, and slowquery.

      Microsoft SQL Server

      Possible values are agent and error.

      MySQL

      Possible values are audit, error, general, and slowquery.

      Oracle

      Possible values are alert, audit, listener, trace, and oemagent.

      PostgreSQL

      Possible values are postgresql and 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 RDS Custom.

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

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

      Amazon Aurora

      Not applicable. 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 RDS Custom.

    • EnableCustomerOwnedIp — (Boolean)

      A value that indicates 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. 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 Relational Database Service User Guide.

      This setting is required for 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:

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

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

        • DBInstanceIdentifier — (String)

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

        • DBInstanceClass — (String)

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

        • Engine — (String)

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

        • DBInstanceStatus — (String)

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

          Contains the master username for the DB instance.

        • DBName — (String)

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

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

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

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

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

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

            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.

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

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

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

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

        • Iops — (Integer)

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

        • OptionGroupMemberships — (Array<map>)

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

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

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

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

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

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

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

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

        • CopyTagsToSnapshot — (Boolean)

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

          Amazon Aurora

          Not applicable. 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)

          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.

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

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

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

          Specifies 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 Relational Database Service User Guide.

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. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

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

Your source DB instance must have backup retention enabled.

Service Reference:

Examples:

Calling the createDBInstanceReadReplica operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  SourceDBInstanceIdentifier: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  CustomIamInstanceProfile: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  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,
  SourceRegion: 'STRING_VALUE',
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  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 five read replicas.

      Constraints:

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

      • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

      • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

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

      • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

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

      Default: Inherits from the source DB instance

      Valid Values: 1150-65535

    • MultiAZ — (Boolean)

      A value that indicates 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 database is a Multi-AZ DB instance.

      This setting doesn't apply to RDS Custom.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

      This setting doesn't apply to RDS Custom.

      Default: Inherits from the source DB instance

    • Iops — (Integer)

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

    • OptionGroupName — (String)

      The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

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

      This setting doesn't apply to RDS Custom.

    • DBParameterGroupName — (String)

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

      If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of 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 Oracle DB instances. It isn't supported 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)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

      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)

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

      • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

      • If supplied, must match the name of an existing DBSubnetGroup.

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

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

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

    • StorageType — (String)

      Specifies the storage type to be associated with the read replica.

      Valid values: standard | gp2 | io1

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

      Default: io1 if the Iops parameter is specified, otherwise gp2

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

    • MonitoringInterval — (Integer)

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

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

      This setting doesn't apply to RDS Custom.

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

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

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

      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.

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

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

      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 action that can be executed 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 action 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 action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action 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 Amazon Web Services 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 action that is called in the destination Amazon Web Services Region, and the action 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 be executed in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

      This setting doesn't apply to RDS Custom.

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

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      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.

    • EnablePerformanceInsights — (Boolean)

      A value that indicates 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.

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

    • PerformanceInsightsRetentionPeriod — (Integer)

      The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      This setting doesn't apply to RDS Custom.

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

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

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

      A value that indicates whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. 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.

    • DomainIAMRoleName — (String)

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

      This setting doesn't apply to RDS Custom.

    • 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 Relational Database Service User Guide.

      This setting is required for RDS Custom.

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

        • DBInstanceIdentifier — (String)

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

        • DBInstanceClass — (String)

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

        • Engine — (String)

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

        • DBInstanceStatus — (String)

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

          Contains the master username for the DB instance.

        • DBName — (String)

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

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

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

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

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

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

            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.

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

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

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

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

        • Iops — (Integer)

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

        • OptionGroupMemberships — (Array<map>)

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

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

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

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

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

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

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

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

        • CopyTagsToSnapshot — (Boolean)

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

          Amazon Aurora

          Not applicable. 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)

          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.

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

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

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

          Specifies 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 Relational Database Service User Guide.

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 (for MySQL 5.6-compatible Aurora)

      • aurora-mysql (for MySQL 5.7-compatible Aurora)

      • aurora-postgresql

      • mariadb

      • 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,
      Description: 'STRING_VALUE',
      IAMAuth: DISABLED | REQUIRED,
      SecretArn: 'STRING_VALUE',
      UserName: 'STRING_VALUE'
    },
    /* more items */
  ],
  DBProxyName: 'STRING_VALUE', /* required */
  EngineFamily: MYSQL | POSTGRESQL, /* 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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

      Possible values include:
      • "MYSQL"
      • "POSTGRESQL"
    • 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)

        Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

        Possible values include:
        • "DISABLED"
        • "REQUIRED"
    • 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)

      A Boolean parameter that 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)

      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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

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

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
        • 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)

          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)

      A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default 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)

          A value that 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.

Note: A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

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)

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

          • CIDRIP — (String)

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

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)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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.

      Example: mySubnetgroup

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

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 action 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 SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

Note: RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.

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. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. 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

    • 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 Events in the Amazon RDS User Guide or 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.

    • Enabled — (Boolean)

      A value that indicates 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)

          A Boolean value indicating if 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 add a primary cluster and a secondary cluster to it. 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 action only applies 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 of the new global database cluster.

    • SourceDBClusterIdentifier — (String)

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

    • Engine — (String)

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

    • EngineVersion — (String)

      The engine version of the Aurora global database.

    • DeletionProtection — (Boolean)

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

    • DatabaseName — (String)

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

    • StorageEncrypted — (Boolean)

      The storage encryption setting for the new global database 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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

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

          • Readers — (Array<String>)

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

          • IsWriter — (Boolean)

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

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

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)

      Specifies the name of the engine that this option group should be associated with.

      Valid Values:

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

            Indicate if this option is persistent.

          • Permanent — (Boolean)

            Indicate if 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)

              A Boolean value that, when true, indicates the option setting can be modified from the default.

            • IsCollection — (Boolean)

              Indicates if 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 status of the VPC security group.

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

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

Returns:

  • (AWS.Request) —

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

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

Deletes a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Service Reference:

Examples:

Calling the deleteCustomAvailabilityZone operation

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

      The custom AZ identifier.

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:

      • CustomAvailabilityZone — (map)

        A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

        For more information about RDS on VMware, see the RDS on VMware User Guide.

        • CustomAvailabilityZoneId — (String)

          The identifier of the custom AZ.

          Amazon RDS generates a unique identifier when a custom AZ is created.

        • CustomAvailabilityZoneName — (String)

          The name of the custom AZ.

        • CustomAvailabilityZoneStatus — (String)

          The status of the custom AZ.

        • VpnDetails — (map)

          Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

          • VpnId — (String)

            The ID of the VPN.

          • VpnTunnelOriginatorIP — (String)

            The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

          • VpnGatewayIp — (String)

            The IP address of network traffic from Amazon Web Services to your on-premises data center.

          • VpnPSK — (String)

            The preshared key (PSK) for the VPN.

          • VpnName — (String)

            The name of the VPN.

          • VpnState — (String)

            The state of the VPN.

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 engine is custom-oracle-ee.

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

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

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

        • IsMajorVersionUpgrade — (Boolean)

          A value that indicates whether 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)

          A value that indicates whether you can use Aurora parallel query with the target engine version.

        • SupportsGlobalDatabases — (Boolean)

          A value that indicates whether you can use Aurora global databases with the target engine version.

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

        A value that 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)

        A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

      • SupportsGlobalDatabases — (Boolean)

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

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.

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

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the deleteDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  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)

      A value that indicates 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

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.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

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

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

        • BackupRetentionPeriod — (Integer)

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

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

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

        • DBClusterParameterGroup — (String)

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

        • DBSubnetGroup — (String)

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

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

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

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

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

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

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

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

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

          • DBInstanceIdentifier — (String)

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

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

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

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

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

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

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

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

        • CloneGroupId — (String)

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

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

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

        • EngineMode — (String)

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

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

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

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

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

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

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

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

          For more information, see Using the Data API for Aurora Serverless 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)

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

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

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

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

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.

Note: This action only applies to Aurora DB clusters.

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.

Note: This action only applies to Aurora DB clusters.

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

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

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

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

        • SnapshotCreateTime — (Date)

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

        • Engine — (String)

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

        • EngineMode — (String)

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

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

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

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

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

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

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

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

        • StorageEncrypted — (Boolean)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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

The DeleteDBInstance action 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. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

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 call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

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)

      A value that indicates 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)

      A value that indicates 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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

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

        • DBInstanceClass — (String)

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

        • Engine — (String)

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

        • DBInstanceStatus — (String)

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

          Contains the master username for the DB instance.

        • DBName — (String)

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

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

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

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

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

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

            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.

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

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

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

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

        • Iops — (Integer)

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

        • OptionGroupMemberships — (Array<map>)

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

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

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

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

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

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

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

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

        • CopyTagsToSnapshot — (Boolean)

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

          Amazon Aurora

          Not applicable. 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)

          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.

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

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

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

          Specifies 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 Relational Database Service User Guide.

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 identifier 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 customer id of the instance that is/was associated with the automated backup.

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

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

          Provides the VPC ID associated with the DB instance

        • InstanceCreateTime — (Date)

          Provides the date and time that the DB instance was created.

        • MasterUsername — (String)

          The license model 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)

          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)

          Specifies whether the automated backup is encrypted.

        • StorageType — (String)

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

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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

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

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
        • 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)

          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)

          A value that 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.

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

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.

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)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

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:

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

      Example: mySubnetgroup

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

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

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

Deletes an 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)

          A Boolean value indicating if 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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

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

          • Readers — (Array<String>)

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

          • IsWriter — (Boolean)

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

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

Returns:

  • (AWS.Request) —

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

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

Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Service Reference:

Examples:

Calling the deleteInstallationMedia operation

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

      The installation medium ID.

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:

      • InstallationMediaId — (String)

        The installation medium ID.

      • CustomAvailabilityZoneId — (String)

        The custom Availability Zone (AZ) that contains the installation media.

      • Engine — (String)

        The DB engine.

      • EngineVersion — (String)

        The engine version of the DB engine.

      • EngineInstallationMediaPath — (String)

        The path to the installation medium for the DB engine.

      • OSInstallationMediaPath — (String)

        The path to the installation medium for the operating system associated with the DB engine.

      • Status — (String)

        The status of the installation medium.

      • FailureCause — (map)

        If an installation media failure occurred, the cause of the failure.

        • Message — (String)

          The reason that an installation media import failed.

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.

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.

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

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

Service Reference:

Examples:

Calling the describeCertificates operation

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

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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:

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

          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.

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

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Service Reference:

Examples:

Calling the describeCustomAvailabilityZones operation

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

      The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

    • Filters — (Array<map>)

      A filter that specifies one or more custom AZs to describe.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeCustomAvailabilityZones 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 DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • CustomAvailabilityZones — (Array<map>)

        The list of CustomAvailabilityZone objects for the Amazon Web Services account.

        • CustomAvailabilityZoneId — (String)

          The identifier of the custom AZ.

          Amazon RDS generates a unique identifier when a custom AZ is created.

        • CustomAvailabilityZoneName — (String)

          The name of the custom AZ.

        • CustomAvailabilityZoneStatus — (String)

          The status of the custom AZ.

        • VpnDetails — (map)

          Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

          • VpnId — (String)

            The ID of the VPN.

          • VpnTunnelOriginatorIP — (String)

            The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

          • VpnGatewayIp — (String)

            The IP address of network traffic from Amazon Web Services to your on-premises data center.

          • VpnPSK — (String)

            The preshared key (PSK) for the VPN.

          • VpnName — (String)

            The name of the VPN.

          • VpnState — (String)

            The state of the VPN.

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.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the describeDBClusterParameterGroups operation

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

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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.

Note: This action only applies to Aurora DB clusters.

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 value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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)

          Specifies the name of the parameter.

        • ParameterValue — (String)

          Specifies the value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          Indicates the source of the parameter value.

        • ApplyType — (String)

          Specifies the engine specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

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

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
        • 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

Returns information about provisioned Aurora DB clusters. This API supports pagination.

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

Note: 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. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DBClusterIdentifier.

    • 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 will only include 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 will only include information about the DB clusters identified by these ARNs.

      • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list will only include information about the DB clusters for these engines.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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)

      Optional Boolean parameter that 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>)

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

        • BackupRetentionPeriod — (Integer)

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

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

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

        • DBClusterParameterGroup — (String)

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

        • DBSubnetGroup — (String)

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

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

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

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

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

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

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

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

        • PreferredMaintenanceWindow — (String)

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

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

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

          • DBInstanceIdentifier — (String)

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

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

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

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

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

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

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

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

        • CloneGroupId — (String)

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

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

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

        • EngineMode — (String)

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

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

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

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

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

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

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

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

          For more information, see Using the Data API for Aurora Serverless 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)

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

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

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

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

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

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

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

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

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

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

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the describeDBClusterSnapshotAttributes operation

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

Parameters:

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

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • DBClusterSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

        Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • DBClusterSnapshotIdentifier — (String)

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

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB cluster snapshot.

          • AttributeName — (String)

            The name of the manual DB cluster snapshot attribute.

            The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value(s) for the manual DB cluster snapshot attribute.

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DB cluster snapshots. This API action supports pagination.

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

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the describeDBClusterSnapshots operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  DBClusterSnapshotIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublic: true || false,
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SnapshotType: 'STRING_VALUE'
};
rds.describeDBClusterSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

      Constraints:

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

    • DBClusterSnapshotIdentifier — (String)

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

      Constraints:

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

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

    • SnapshotType — (String)

      The type of DB cluster snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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

    • Filters — (Array<map>)

      A filter that specifies one or more DB cluster snapshots to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

      • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

      • snapshot-type - Accepts types of DB cluster snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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 DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterSnapshots — (Array<map>)

        Provides a list of DB cluster snapshots for the user.

        • AvailabilityZones — (Array<String>)

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

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

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

        • SnapshotCreateTime — (Date)

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

        • Engine — (String)

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

        • EngineMode — (String)

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

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

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

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

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

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

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

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

        • StorageEncrypted — (Boolean)

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

Waiter Resource States:

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

Returns a list of the available DB engines.

Service Reference:

Examples:

Calling the describeDBEngineVersions operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE',
  DefaultOnly: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludeAll: true || false,
  ListSupportedCharacterSets: true || false,
  ListSupportedTimezones: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBEngineVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The database engine to return.

      Valid Values:

      • aurora (for MySQL 5.6-compatible Aurora)

      • aurora-mysql (for MySQL 5.7-compatible Aurora)

      • aurora-postgresql

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • EngineVersion — (String)

      The database engine version to return.

      Example: 5.1.49

    • DBParameterGroupFamily — (String)

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

      Constraints:

      • If supplied, must match an existing DBParameterGroupFamily.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more than the MaxRecords value is available, 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • DefaultOnly — (Boolean)

      A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

    • ListSupportedCharacterSets — (Boolean)

      A value that indicates whether to list the supported character sets for each engine version.

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

      For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

    • ListSupportedTimezones — (Boolean)

      A value that indicates whether to list the supported time zones for each engine version.

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

      For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

    • IncludeAll — (Boolean)

      A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBEngineVersions — (Array<map>)

        A list of DBEngineVersion elements.

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

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

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

          • IsMajorVersionUpgrade — (Boolean)

            A value that indicates whether 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)

            A value that indicates whether you can use Aurora parallel query with the target engine version.

          • SupportsGlobalDatabases — (Boolean)

            A value that indicates whether you can use Aurora global databases with the target engine version.

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

          A value that 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)

          A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

        • SupportsGlobalDatabases — (Boolean)

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

Returns:

  • (AWS.Request) —

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

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

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Service Reference:

Examples:

Calling the describeDBInstanceAutomatedBackups operation

var params = {
  DBInstanceAutomatedBackupsArn: 'STRING_VALUE',
  DBInstanceIdentifier: 'STRING_VALUE',
  DbiResourceId: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBInstanceAutomatedBackups(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 resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

    • DBInstanceIdentifier — (String)

      (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' 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

        • active - automated backups for current instances

        • retained - automated backups for deleted instances and after backup replication is stopped

        • creating - automated backups that are waiting for the first automated snapshot to be available

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

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

    • Marker — (String)

      The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    • DBInstanceAutomatedBackupsArn — (String)

      The Amazon Resource Name (ARN) of the replicated automated backups, 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:

      • Marker — (String)

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

      • DBInstanceAutomatedBackups — (Array<map>)

        A list of DBInstanceAutomatedBackup instances.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the automated backups.

        • DbiResourceId — (String)

          The identifier 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 customer id of the instance that is/was associated with the automated backup.

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

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

          Provides the VPC ID associated with the DB instance

        • InstanceCreateTime — (Date)

          Provides the date and time that the DB instance was created.

        • MasterUsername — (String)

          The license model 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)

          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)

          Specifies whether the automated backup is encrypted.

        • StorageType — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns information about provisioned RDS instances. This API supports pagination.

Note: This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Service Reference:

Examples:

Calling the describeDBInstances operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

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

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

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

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

      • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

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

        • DBInstanceClass — (String)

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

        • Engine — (String)

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

        • DBInstanceStatus — (String)

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

          Contains the master username for the DB instance.

        • DBName — (String)

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

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

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

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

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

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

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

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

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

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

            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.

        • LatestRestorableTime — (Date)

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

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

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

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

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

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

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

        • Iops — (Integer)

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

        • OptionGroupMemberships — (Array<map>)

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

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

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

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

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

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

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

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

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

        • CopyTagsToSnapshot — (Boolean)

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

          Amazon Aurora

          Not applicable. 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)

          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.

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

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

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

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns a list of DB log files for the DB instance.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the describeDBLogFiles operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  FileLastWritten: 'NUMBER_VALUE',
  FileSize: 'NUMBER_VALUE',
  FilenameContains: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBLogFiles(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 customer-assigned name of the DB instance that contains the log files you want to list.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • FilenameContains — (String)

      Filters the available log files for log file names that contain the specified string.

    • FileLastWritten — (Integer)

      Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

    • FileSize — (Integer)

      Filters the available log files for files larger than the specified size.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so 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:

      • DescribeDBLogFiles — (Array<map>)

        The DB log files returned.

        • LogFileName — (String)

          The name of the log file for the specified DB instance.

        • LastWritten — (Integer)

          A POSIX timestamp when the last log entry was written.

        • Size — (Integer)

          The size, in bytes, of the log file for the specified DB instance.

      • Marker — (String)

        A pagination token that can be used in a later DescribeDBLogFiles request.

Returns:

  • (AWS.Request) —

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

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

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

Service Reference:

Examples:

Calling the describeDBParameterGroups operation

var params = {
  DBParameterGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBParameterGroups(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 a specific DB 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.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBParameterGroups — (Array<map>)

        A list of DBParameterGroup instances.

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

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

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

Service Reference:

Examples:

Calling the describeDBParameters operation

var params = {
  DBParameterGroupName: '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.describeDBParameters(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 a specific DB parameter group to return details for.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

    • Source — (String)

      The parameter types to return.

      Default: All parameter types returned

      Valid Values: user | system | engine-default

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBParameters 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>)

        A list of Parameter values.

        • ParameterName — (String)

          Specifies the name of the parameter.

        • ParameterValue — (String)

          Specifies the value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          Indicates the source of the parameter value.

        • ApplyType — (String)

          Specifies the engine specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

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

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
        • SupportedEngineModes — (Array<String>)

          The valid DB engine modes.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DB proxies.

Service Reference:

Examples:

Calling the describeDBProxies operation

var params = {
  DBProxyName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBProxies(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. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • DBProxies — (Array<map>)

        A return value representing an arbitrary number of DBProxy data structures.

        • 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

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

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
        • 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)

          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.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DB proxy endpoints.

Service Reference:

Examples:

Calling the describeDBProxyEndpoints operation

var params = {
  DBProxyEndpointName: 'STRING_VALUE',
  DBProxyName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBProxyEndpoints(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 whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

    • DBProxyEndpointName — (String)

      The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • DBProxyEndpoints — (Array<map>)

        The list of ProxyEndpoint objects returned by the API operation.

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

          A value that 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.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

Service Reference:

Examples:

Calling the describeDBProxyTargetGroups operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TargetGroupName: 'STRING_VALUE'
};
rds.describeDBProxyTargetGroups(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 associated with the target group.

    • TargetGroupName — (String)

      The identifier of the DBProxyTargetGroup to describe.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • TargetGroups — (Array<map>)

        An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

        • DBProxyName — (String)

          The identifier for the RDS proxy associated with this target group.

        • TargetGroupName — (String)

          The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

        • TargetGroupArn — (String)

          The Amazon Resource Name (ARN) representing the target group.

        • IsDefault — (Boolean)

          Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

        • Status — (String)

          The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

        • ConnectionPoolConfig — (map)

          The settings that determine the size and behavior of the connection pool for the target group.

          • MaxConnectionsPercent — (Integer)

            The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

          • MaxIdleConnectionsPercent — (Integer)

            Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

          • ConnectionBorrowTimeout — (Integer)

            The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

          • SessionPinningFilters — (Array<String>)

            Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

          • InitQuery — (String)

            One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

        • CreatedDate — (Date)

          The date and time when the target group was first created.

        • UpdatedDate — (Date)

          The date and time when the target group was last updated.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DBProxyTarget objects. This API supports pagination.

Service Reference:

Examples:

Calling the describeDBProxyTargets operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TargetGroupName: 'STRING_VALUE'
};
rds.describeDBProxyTargets(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 DBProxyTarget to describe.

    • TargetGroupName — (String)

      The identifier of the DBProxyTargetGroup to describe.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Targets — (Array<map>)

        An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

        • Endpoint — (String)

          The writer endpoint for the RDS DB instance or Aurora DB cluster.

        • TrackedClusterId — (String)

          The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

        • RdsResourceId — (String)

          The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

        • Port — (Integer)

          The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

        • Type — (String)

          Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

          Possible values include:
          • "RDS_INSTANCE"
          • "RDS_SERVERLESS_ENDPOINT"
          • "TRACKED_CLUSTER"
        • Role — (String)

          A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

          Possible values include:
          • "READ_WRITE"
          • "READ_ONLY"
          • "UNKNOWN"
        • TargetHealth — (map)

          Information about the connection health of the RDS Proxy target.

          • State — (String)

            The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

            registering > unavailable > available > unavailable > available

            Possible values include:
            • "REGISTERING"
            • "AVAILABLE"
            • "UNAVAILABLE"
          • Reason — (String)

            The reason for the current health State of the RDS Proxy target.

            Possible values include:
            • "UNREACHABLE"
            • "CONNECTION_FAILED"
            • "AUTH_FAILURE"
            • "PENDING_PROXY_CAPACITY"
            • "INVALID_REPLICATION_STATE"
          • Description — (String)

            A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

Service Reference:

Examples:

Calling the describeDBSecurityGroups operation

var params = {
  DBSecurityGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBSecurityGroups(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 return details for.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBSecurityGroups — (Array<map>)

        A list of DBSecurityGroup instances.

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

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

          • CIDRIP — (String)

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

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

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

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Service Reference:

Examples:

Calling the describeDBSnapshotAttributes operation

var params = {
  DBSnapshotIdentifier: 'STRING_VALUE' /* required */
};
rds.describeDBSnapshotAttributes(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 to describe the attributes for.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • DBSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

        Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

        • DBSnapshotIdentifier — (String)

          The identifier of the manual DB snapshot that the attributes apply to.

        • DBSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB snapshot.

          • AttributeName — (String)

            The name of the manual DB snapshot attribute.

            The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value or values for the manual DB snapshot attribute.

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

Returns:

  • (AWS.Request) —

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

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

Returns information about DB snapshots. This API action supports pagination.

Service Reference:

Examples:

Calling the describeDBSnapshots operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE',
  DBSnapshotIdentifier: 'STRING_VALUE',
  DbiResourceId: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublic: true || false,
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SnapshotType: 'STRING_VALUE'
};
rds.describeDBSnapshots(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 ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

      Constraints:

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

    • DBSnapshotIdentifier — (String)

      A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBSnapshot.

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

    • SnapshotType — (String)

      The type of snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

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

      • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

        For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

        The awsbackup type does not apply to Aurora.

      If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

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

    • Filters — (Array<map>)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

      This setting doesn't apply to RDS Custom.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

      This setting doesn't apply to RDS Custom.

    • DbiResourceId — (String)

      A specific DB resource ID to describe.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBSnapshots — (Array<map>)

        A list of DBSnapshot instances.

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

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

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

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

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

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

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

Service Reference:

Examples:

Calling the describeDBSubnetGroups operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBSubnetGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the DB subnet group to return details for.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • DBSubnetGroups — (Array<map>)

        A list of DBSubnetGroup instances.

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

Returns:

  • (AWS.Request) —

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

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

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

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

Service Reference:

Examples:

Calling the describeEngineDefaultClusterParameters operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeEngineDefaultClusterParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • EngineDefaults — (map)

        Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

        • DBParameterGroupFamily — (String)

          Specifies the name of the DB parameter group family that the engine default parameters apply to.

        • Marker — (String)

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

        • Parameters — (Array<map>)

          Contains a list of engine default parameters.

          • ParameterName — (String)

            Specifies the name of the parameter.

          • ParameterValue — (String)

            Specifies the value of the parameter.

          • Description — (String)

            Provides a description of the parameter.

          • Source — (String)

            Indicates the source of the parameter value.

          • ApplyType — (String)

            Specifies the engine specific parameters type.

          • DataType — (String)

            Specifies the valid data type for the parameter.

          • AllowedValues — (String)

            Specifies the valid range of values for the parameter.

          • IsModifiable — (Boolean)

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

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

          • ApplyMethod — (String)

            Indicates when to apply parameter updates.

            Possible values include:
            • "immediate"
            • "pending-reboot"
          • SupportedEngineModes — (Array<String>)

            The valid DB engine modes.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the describeEngineDefaultParameters operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeEngineDefaultParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the DB parameter group family.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • EngineDefaults — (map)

        Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

        • DBParameterGroupFamily — (String)

          Specifies the name of the DB parameter group family that the engine default parameters apply to.

        • Marker — (String)

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

        • Parameters — (Array<map>)

          Contains a list of engine default parameters.

          • ParameterName — (String)

            Specifies the name of the parameter.

          • ParameterValue — (String)

            Specifies the value of the parameter.

          • Description — (String)

            Provides a description of the parameter.

          • Source — (String)

            Indicates the source of the parameter value.

          • ApplyType — (String)

            Specifies the engine specific parameters type.

          • DataType — (String)

            Specifies the valid data type for the parameter.

          • AllowedValues — (String)

            Specifies the valid range of values for the parameter.

          • IsModifiable — (Boolean)

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

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

          • ApplyMethod — (String)

            Indicates when to apply parameter updates.

            Possible values include:
            • "immediate"
            • "pending-reboot"
          • SupportedEngineModes — (Array<String>)

            The valid DB engine modes.

Returns:

  • (AWS.Request) —

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

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

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Events in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the describeEventCategories operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  SourceType: 'STRING_VALUE'
};
rds.describeEventCategories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The type of source that is generating the events.

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

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • EventCategoriesMapList — (Array<map>)

        A list of EventCategoriesMap data types.

        • SourceType — (String)

          The source type that the returned categories belong to

        • EventCategories — (Array<String>)

          The event categories for the specified source type

Returns:

  • (AWS.Request) —

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

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

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be obtained by providing the name as a parameter.

Note: By default, the past hour of events are returned.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 'NUMBER_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceIdentifier: 'STRING_VALUE',
  SourceType: db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot | custom-engine-version,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
rds.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

      • If SourceIdentifier is 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.

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

    • SourceType — (String)

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

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

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • Duration — (Integer)

      The number of minutes to retrieve events for.

      Default: 60

    • EventCategories — (Array<String>)

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

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEvents 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 Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • Events — (Array<map>)

        A list of Event instances.

        • SourceIdentifier — (String)

          Provides the identifier for the source of the event.

        • SourceType — (String)

          Specifies the source type for this event.

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

          Provides the text of this event.

        • EventCategories — (Array<String>)

          Specifies the category for the event.

        • Date — (Date)

          Specifies the date and time of the event.

        • SourceArn — (String)

          The Amazon Resource Name (ARN) for the event.

Returns:

  • (AWS.Request) —

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

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

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

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

Service Reference:

Examples:

Calling the describeEventSubscriptions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SubscriptionName: 'STRING_VALUE'
};
rds.describeEventSubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the RDS event notification subscription you want to describe.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • EventSubscriptionsList — (Array<map>)

        A list of EventSubscriptions data types.

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

          A Boolean value indicating if 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.

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

Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

Service Reference:

Examples:

Calling the describeExportTasks operation

var params = {
  ExportTaskIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceArn: 'STRING_VALUE'
};
rds.describeExportTasks(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 export task to be described.

    • SourceArn — (String)

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

    • Filters — (Array<map>)

      Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

      Supported filters include the following:

      • export-task-identifier - An identifier for the snapshot export task.

      • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

      • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

      • status - The status of the export task. Must be lowercase. Valid statuses are the following:

        • canceled

        • canceling

        • complete

        • failed

        • starting

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

        A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.

      • ExportTasks — (Array<map>)

        Information about an export of a snapshot to Amazon S3.

        • ExportTaskIdentifier — (String)

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

        • SourceArn — (String)

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

        • ExportOnly — (Array<String>)

          The data exported from the snapshot. Valid values are the following:

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

          • database.table table-name - Export a table of the snapshot. 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. 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 that the snapshot was created.

        • TaskStartTime — (Date)

          The time that the snapshot export task started.

        • TaskEndTime — (Date)

          The time that the snapshot export task completed.

        • S3Bucket — (String)

          The Amazon S3 bucket that the snapshot is exported to.

        • S3Prefix — (String)

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

        • IamRoleArn — (String)

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

        • KmsKeyId — (String)

          The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

        • Status — (String)

          The progress status of the export task.

        • PercentProgress — (Integer)

          The progress of the snapshot 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 export task.

Returns:

  • (AWS.Request) —

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

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

Returns information about Aurora global database clusters. This API supports pagination.

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

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the describeGlobalClusters operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GlobalClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
rds.describeGlobalClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      Constraints:

      • If supplied, must match an existing DBClusterIdentifier.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • GlobalClusters — (Array<map>)

        The list of global clusters returned by this request.

        • 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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

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

          • Readers — (Array<String>)

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

          • IsWriter — (Boolean)

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

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

Returns:

  • (AWS.Request) —

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

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

Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

Service Reference:

Examples:

Calling the describeInstallationMedia operation

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

      The installation medium ID.

    • Filters — (Array<map>)

      A filter that specifies one or more installation media to describe. Supported filters include the following:

      • custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers.

      • engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers.

        For more information about the valid engines for installation media, see ImportInstallationMedia.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Marker — (String)

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

      • InstallationMedia — (Array<map>)

        The list of InstallationMedia objects for the Amazon Web Services account.

        • InstallationMediaId — (String)

          The installation medium ID.

        • CustomAvailabilityZoneId — (String)

          The custom Availability Zone (AZ) that contains the installation media.

        • Engine — (String)

          The DB engine.

        • EngineVersion — (String)

          The engine version of the DB engine.

        • EngineInstallationMediaPath — (String)

          The path to the installation medium for the DB engine.

        • OSInstallationMediaPath — (String)

          The path to the installation medium for the operating system associated with the DB engine.

        • Status — (String)

          The status of the installation medium.

        • FailureCause — (map)

          If an installation media failure occurred, the cause of the failure.

          • Message — (String)

            The reason that an installation media import failed.

Returns:

  • (AWS.Request) —

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

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

Describes all available options.

Service Reference:

Examples:

Calling the describeOptionGroupOptions operation

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

      A required parameter. Options available for the given engine name are described.

      Valid Values:

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • MajorEngineVersion — (String)

      If specified, filters the results to include only options for the specified major engine version.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • OptionGroupOptions — (Array<map>)

        List of available option group options.

        • Name — (String)

          The name of the option.

        • Description — (String)

          The description of the option.

        • EngineName — (String)

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

        • MajorEngineVersion — (String)

          Indicates the major engine version that the option is available for.

        • MinimumRequiredMinorEngineVersion — (String)

          The minimum required engine version for the option to be applied.

        • PortRequired — (Boolean)

          Specifies whether the option requires a port.

        • DefaultPort — (Integer)

          If the option requires a port, specifies the default port for the option.

        • OptionsDependedOn — (Array<String>)

          The options that are prerequisites for this option.

        • OptionsConflictsWith — (Array<String>)

          The options that conflict with this option.

        • Persistent — (Boolean)

          Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

        • Permanent — (Boolean)

          Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

        • RequiresAutoMinorEngineVersionUpgrade — (Boolean)

          If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

        • VpcOnly — (Boolean)

          If true, you can only use this option with a DB instance that is in a VPC.

        • SupportsOptionVersionDowngrade — (Boolean)

          If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

        • OptionGroupOptionSettings — (Array<map>)

          The option settings that are available (and the default value) for each option in an option group.

          • SettingName — (String)

            The name of the option group option.

          • SettingDescription — (String)

            The description of the option group option.

          • DefaultValue — (String)

            The default value for the option group option.

          • ApplyType — (String)

            The DB engine specific parameter type for the option group option.

          • AllowedValues — (String)

            Indicates the acceptable values for the option group option.

          • IsModifiable — (Boolean)

            Boolean value where true indicates that this option group option can be changed from the default value.

          • IsRequired — (Boolean)

            Boolean value where true indicates that a value must be specified for this option setting of the option group option.

          • MinimumEngineVersionPerAllowedValue — (Array<map>)

            The minimum DB engine version required for the corresponding allowed value for this option setting.

            • AllowedValue — (String)

              The allowed value for an option setting.

            • MinimumEngineVersion — (String)

              The minimum DB engine version required for the allowed value.

        • OptionGroupOptionVersions — (Array<map>)

          The versions that are available for the option.

          • Version — (String)

            The version of the option.

          • IsDefault — (Boolean)

            True if the version is the default version of the option, and otherwise false.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

Describes the available option groups.

Service Reference:

Examples:

Calling the describeOptionGroups operation

var params = {
  EngineName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MajorEngineVersion: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  OptionGroupName: 'STRING_VALUE'
};
rds.describeOptionGroups(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 describe. Can't be supplied together with EngineName or MajorEngineVersion.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • EngineName — (String)

      Filters the list of option groups to only include groups associated with a specific database engine.

      Valid Values:

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • MajorEngineVersion — (String)

      Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

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:

      • OptionGroupsList — (Array<map>)

        List of option groups.

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

            Indicate if this option is persistent.

          • Permanent — (Boolean)

            Indicate if 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)

              A Boolean value that, when true, indicates the option setting can be modified from the default.

            • IsCollection — (Boolean)

              Indicates if 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 status of the VPC security group.

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

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

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the describeOrderableDBInstanceOptions operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZoneGroup: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseModel: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Vpc: true || false
};
rds.describeOrderableDBInstanceOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the engine to retrieve DB instance options for.

      Valid Values:

      • aurora (for MySQL 5.6-compatible Aurora)

      • aurora-mysql (for MySQL 5.7-compatible Aurora)

      • aurora-postgresql

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • EngineVersion — (String)

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

    • DBInstanceClass — (String)

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

    • LicenseModel — (String)

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

      RDS Custom supports only the BYOL licensing model.

    • AvailabilityZoneGroup — (String)

      The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

      Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

      This setting doesn't apply to RDS Custom.

    • Vpc — (Boolean)

      A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

      RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • OrderableDBInstanceOptions — (Array<map>)

        An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

        • Engine — (String)

          The engine type of a DB instance.

        • EngineVersion — (String)

          The engine version of a DB instance.

        • DBInstanceClass — (String)

          The DB instance class for a DB instance.

        • LicenseModel — (String)

          The license model for a DB instance.

        • AvailabilityZoneGroup — (String)

          The Availability Zone group for a DB instance.

        • AvailabilityZones — (Array<map>)

          A list of Availability Zones for a DB instance.

          • Name — (String)

            The name of the Availability Zone.

        • MultiAZCapable — (Boolean)

          Indicates whether a DB instance is Multi-AZ capable.

        • ReadReplicaCapable — (Boolean)

          Indicates whether a DB instance can have a read replica.

        • Vpc — (Boolean)

          Indicates whether a DB instance is in a VPC.

        • SupportsStorageEncryption — (Boolean)

          Indicates whether a DB instance supports encrypted storage.

        • StorageType — (String)

          Indicates the storage type for a DB instance.

        • SupportsIops — (Boolean)

          Indicates whether a DB instance supports provisioned IOPS.

        • SupportsEnhancedMonitoring — (Boolean)

          Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

        • SupportsIAMDatabaseAuthentication — (Boolean)

          Indicates whether a DB instance supports IAM database authentication.

        • SupportsPerformanceInsights — (Boolean)

          True if a DB instance supports Performance Insights, otherwise false.

        • MinStorageSize — (Integer)

          Minimum storage size for a DB instance.

        • MaxStorageSize — (Integer)

          Maximum storage size for a DB instance.

        • MinIopsPerDbInstance — (Integer)

          Minimum total provisioned IOPS for a DB instance.

        • MaxIopsPerDbInstance — (Integer)

          Maximum total provisioned IOPS for a DB instance.

        • MinIopsPerGib — (Float)

          Minimum provisioned IOPS per GiB for a DB instance.

        • MaxIopsPerGib — (Float)

          Maximum provisioned IOPS per GiB for a DB instance.

        • AvailableProcessorFeatures — (Array<map>)

          A list of the available processor features for the DB instance class of a DB instance.

          • Name — (String)

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

          • DefaultValue — (String)

            The default value for the processor feature of the DB instance class.

          • AllowedValues — (String)

            The allowed values for the processor feature of the DB instance class.

        • SupportedEngineModes — (Array<String>)

          A list of the supported DB engine modes.

        • SupportsStorageAutoscaling — (Boolean)

          Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

        • SupportsKerberosAuthentication — (Boolean)

          Whether a DB instance supports Kerberos Authentication.

        • OutpostCapable — (Boolean)

          Whether a DB instance supports RDS on Outposts.

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

        • SupportedActivityStreamModes — (Array<String>)

          The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

        • SupportsGlobalDatabases — (Boolean)

          A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the describePendingMaintenanceActions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ResourceIdentifier: 'STRING_VALUE'
};
rds.describePendingMaintenanceActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • Filters — (Array<map>)

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

      Supported filters:

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

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

      • Name — required — (String)

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

      • Values — required — (Array<String>)

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

    • Marker — (String)

      An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records 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 that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • PendingMaintenanceActions — (Array<map>)

        A list of the pending maintenance actions for the 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.

      • Marker — (String)

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

Returns:

  • (AWS.Request) —

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

describeReservedDBInstances(params = {}, callback) ⇒ AWS.Request

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Service Reference:

Examples:

Calling the describeReservedDBInstances operation

var params = {
  DBInstanceClass: 'STRING_VALUE',
  Duration: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LeaseId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  MultiAZ: true || false,
  OfferingType: 'STRING_VALUE',
  ProductDescription: 'STRING_VALUE',
  ReservedDBInstanceId: 'STRING_VALUE',
  ReservedDBInstancesOfferingId: 'STRING_VALUE'
};
rds.describeReservedDBInstances(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: {}) —
    • ReservedDBInstanceId — (String)

      The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

    • ReservedDBInstancesOfferingId — (String)

      The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    • DBInstanceClass — (String)

      The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    • Duration — (String)

      The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

      Valid Values: 1 | 3 | 31536000 | 94608000

    • ProductDescription — (String)

      The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    • OfferingType — (String)

      The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

      Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

    • MultiAZ — (Boolean)

      A value that indicates whether to show only those reservations that support Multi-AZ.

    • LeaseId — (String)

      The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

      Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more than the MaxRecords value is available, 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • ReservedDBInstances — (Array<map>)

        A list of reserved DB instances.

        • ReservedDBInstanceId — (String)

          The unique identifier for the reservation.

        • ReservedDBInstancesOfferingId — (String)

          The offering identifier.

        • DBInstanceClass — (String)

          The DB instance class for the reserved DB instance.

        • StartTime — (Date)

          The time the reservation started.

        • Duration — (Integer)

          The duration of the reservation in seconds.

        • FixedPrice — (Float)

          The fixed price charged for this reserved DB instance.

        • UsagePrice — (Float)

          The hourly price charged for this reserved DB instance.

        • CurrencyCode — (String)

          The currency code for the reserved DB instance.

        • DBInstanceCount — (Integer)

          The number of reserved DB instances.

        • ProductDescription — (String)

          The description of the reserved DB instance.

        • OfferingType — (String)

          The offering type of this reserved DB instance.

        • MultiAZ — (Boolean)

          Indicates if the reservation applies to Multi-AZ deployments.

        • State — (String)

          The state of the reserved DB instance.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved DB instance.

          • RecurringChargeAmount — (Float)

            The amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

        • ReservedDBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the reserved DB instance.

        • LeaseId — (String)

          The unique identifier for the lease associated with the reserved DB instance.

          Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedDBInstancesOfferings(params = {}, callback) ⇒ AWS.Request

Lists available reserved DB instance offerings.

Service Reference:

Examples:

Calling the describeReservedDBInstancesOfferings operation

var params = {
  DBInstanceClass: 'STRING_VALUE',
  Duration: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  MultiAZ: true || false,
  OfferingType: 'STRING_VALUE',
  ProductDescription: 'STRING_VALUE',
  ReservedDBInstancesOfferingId: 'STRING_VALUE'
};
rds.describeReservedDBInstancesOfferings(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: {}) —
    • ReservedDBInstancesOfferingId — (String)

      The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    • DBInstanceClass — (String)

      The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    • Duration — (String)

      Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

      Valid Values: 1 | 3 | 31536000 | 94608000

    • ProductDescription — (String)

      Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

      Note: The results show offerings that partially match the filter value.
    • OfferingType — (String)

      The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

      Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

    • MultiAZ — (Boolean)

      A value that indicates whether to show only those reservations that support Multi-AZ.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more than the MaxRecords value is available, 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • ReservedDBInstancesOfferings — (Array<map>)

        A list of reserved DB instance offerings.

        • ReservedDBInstancesOfferingId — (String)

          The offering identifier.

        • DBInstanceClass — (String)

          The DB instance class for the reserved DB instance.

        • Duration — (Integer)

          The duration of the offering in seconds.

        • FixedPrice — (Float)

          The fixed price charged for this offering.

        • UsagePrice — (Float)

          The hourly price charged for this offering.

        • CurrencyCode — (String)

          The currency code for the reserved DB instance offering.

        • ProductDescription — (String)

          The database engine used by the offering.

        • OfferingType — (String)

          The offering type.

        • MultiAZ — (Boolean)

          Indicates if the offering applies to Multi-AZ deployments.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved DB instance.

          • RecurringChargeAmount — (Float)

            The amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSourceRegions(params = {}, callback) ⇒ AWS.Request

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

Service Reference:

Examples:

Calling the describeSourceRegions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  RegionName: 'STRING_VALUE'
};
rds.describeSourceRegions(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: {}) —
    • RegionName — (String)

      The source Amazon Web Services Region name. For example, us-east-1.

      Constraints:

      • Must specify a valid Amazon Web Services Region name.

    • 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 DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • SourceRegions — (Array<map>)

        A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.

        • RegionName — (String)

          The name of the source Amazon Web Services Region.

        • Endpoint — (String)

          The endpoint for the source Amazon Web Services Region endpoint.

        • Status — (String)

          The status of the source Amazon Web Services Region.

        • SupportsDBInstanceAutomatedBackupsReplication — (Boolean)

          Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeValidDBInstanceModifications(params = {}, callback) ⇒ AWS.Request

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the describeValidDBInstanceModifications operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE' /* required */
};
rds.describeValidDBInstanceModifications(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 customer identifier or the ARN of your 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:

      • ValidDBInstanceModificationsMessage — (map)

        Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

        • Storage — (Array<map>)

          Valid storage options for your DB instance.

          • StorageType — (String)

            The valid storage types for your DB instance. For example, gp2, io1.

          • StorageSize — (Array<map>)

            The valid range of storage in gibibytes (GiB). For example, 100 to 16384.

            • From — (Integer)

              The minimum value in the range.

            • To — (Integer)

              The maximum value in the range.

            • Step — (Integer)

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

          • ProvisionedIops — (Array<map>)

            The valid range of provisioned IOPS. For example, 1000-20000.

            • From — (Integer)

              The minimum value in the range.

            • To — (Integer)

              The maximum value in the range.

            • Step — (Integer)

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

          • IopsToStorageRatio — (Array<map>)

            The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

            • From — (Float)

              The minimum value in the range.

            • To — (Float)

              The maximum value in the range.

          • SupportsStorageAutoscaling — (Boolean)

            Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

        • ValidProcessorFeatures — (Array<map>)

          Valid processor features for your DB instance.

          • Name — (String)

            The name of the processor feature. Valid names are coreCount and threadsPerCore.

          • DefaultValue — (String)

            The default value for the processor feature of the DB instance class.

          • AllowedValues — (String)

            The allowed values for the processor feature of the DB instance class.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

downloadDBLogFilePortion(params = {}, callback) ⇒ AWS.Request

Downloads all or a portion of the specified log file, up to 1 MB in size.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the downloadDBLogFilePortion operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  LogFileName: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  NumberOfLines: 'NUMBER_VALUE'
};
rds.downloadDBLogFilePortion(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 customer-assigned name of the DB instance that contains the log files you want to list.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • LogFileName — (String)

      The name of the log file to be downloaded.

    • Marker — (String)

      The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

    • NumberOfLines — (Integer)

      The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

      If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

      • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

      • If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.

      • If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

      • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LogFileData — (String)

        Entries from the specified log file.

      • Marker — (String)

        A pagination token that can be used in a later DownloadDBLogFilePortion request.

      • AdditionalDataPending — (Boolean)

        Boolean value that if true, indicates there is more data to be downloaded.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

failoverDBCluster(params = {}, callback) ⇒ AWS.Request

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the failoverDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  TargetDBInstanceIdentifier: 'STRING_VALUE'
};
rds.failoverDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • TargetDBInstanceIdentifier — (String)

      The name of the instance to promote to the primary instance.

      You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBCluster — (map)

        Contains the details of an Amazon Aurora DB cluster.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

failoverGlobalCluster(params = {}, callback) ⇒ AWS.Request

Initiates the failover process for an Aurora global database (GlobalCluster).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.

Note: This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

Service Reference:

Examples:

Calling the failoverGlobalCluster operation

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE', /* required */
  TargetDbClusterIdentifier: 'STRING_VALUE' /* required */
};
rds.failoverGlobalCluster(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)

      Identifier of the Aurora global database (GlobalCluster) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.

      Constraints:

      • Must match the identifier of an existing GlobalCluster (Aurora global database).

    • TargetDbClusterIdentifier — (String)

      Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its 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:

      • 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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Aurora cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

          • IsWriter — (Boolean)

            Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

importInstallationMedia(params = {}, callback) ⇒ AWS.Request

Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

Service Reference:

Examples:

Calling the importInstallationMedia operation

var params = {
  CustomAvailabilityZoneId: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  EngineInstallationMediaPath: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  OSInstallationMediaPath: 'STRING_VALUE' /* required */
};
rds.importInstallationMedia(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: {}) —
    • CustomAvailabilityZoneId — (String)

      The identifier of the custom Availability Zone (AZ) to import the installation media to.

    • Engine — (String)

      The name of the database engine to be used for this instance.

      The list only includes supported DB engines that require an on-premises customer provided license.

      Valid Values:

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • EngineVersion — (String)

      The version number of the database engine to use.

      For a list of valid engine versions, call DescribeDBEngineVersions.

      The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.

      Microsoft SQL Server

      See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

    • EngineInstallationMediaPath — (String)

      The path to the installation medium for the specified DB engine.

      Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso

    • OSInstallationMediaPath — (String)

      The path to the installation medium for the operating system associated with the specified DB engine.

      Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso

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:

      • InstallationMediaId — (String)

        The installation medium ID.

      • CustomAvailabilityZoneId — (String)

        The custom Availability Zone (AZ) that contains the installation media.

      • Engine — (String)

        The DB engine.

      • EngineVersion — (String)

        The engine version of the DB engine.

      • EngineInstallationMediaPath — (String)

        The path to the installation medium for the DB engine.

      • OSInstallationMediaPath — (String)

        The path to the installation medium for the operating system associated with the DB engine.

      • Status — (String)

        The status of the installation medium.

      • FailureCause — (map)

        If an installation media failure occurred, the cause of the failure.

        • Message — (String)

          The reason that an installation media import failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
rds.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceName — (String)

      The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    • Filters — (Array<map>)

      This parameter isn't currently supported.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagList — (Array<map>)

        List of tags returned by the ListTagsForResource operation.

        • 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.

modifyCertificates(params = {}, callback) ⇒ AWS.Request

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override.

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

You might need to override the default certificate in the following situations:

  • You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.

  • RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

Service Reference:

Examples:

Calling the modifyCertificates operation

var params = {
  CertificateIdentifier: 'STRING_VALUE',
  RemoveCustomerOverride: true || false
};
rds.modifyCertificates(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 new default certificate identifier to override the current one with.

      To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.

    • RemoveCustomerOverride — (Boolean)

      A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system 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. The data object has the following properties:

      • Certificate — (map)

        A CA certificate for an 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)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyCurrentDBClusterCapacity(params = {}, callback) ⇒ AWS.Request

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
Note: This action only applies to Aurora Serverless DB clusters.

Service Reference:

Examples:

Calling the modifyCurrentDBClusterCapacity operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Capacity: 'NUMBER_VALUE',
  SecondsBeforeTimeout: 'NUMBER_VALUE',
  TimeoutAction: 'STRING_VALUE'
};
rds.modifyCurrentDBClusterCapacity(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 cluster being modified. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB cluster.

    • Capacity — (Integer)

      The DB cluster capacity.

      When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

      Constraints:

      • 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.

    • SecondsBeforeTimeout — (Integer)

      The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

      Specify a value between 10 and 600 seconds.

    • TimeoutAction — (String)

      The action to take when the timeout is reached, 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.

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)

        A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

      • PendingCapacity — (Integer)

        A value that specifies the capacity that the DB cluster scales to next.

      • CurrentCapacity — (Integer)

        The current capacity of the DB cluster.

      • SecondsBeforeTimeout — (Integer)

        The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

      • TimeoutAction — (String)

        The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyCustomDBEngineVersion(params = {}, callback) ⇒ AWS.Request

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.

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 ModifyCustomDbEngineVersion 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 ModifyCustomDbEngineVersion event.

For more information, see Modifying CEV status in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the modifyCustomDBEngineVersion operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Status: available | inactive | inactive-except-restore
};
rds.modifyCustomDBEngineVersion(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 DB engine. The only supported value is custom-oracle-ee.

    • EngineVersion — (String)

      The custom engine version (CEV) that you want to modify. 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.

    • Description — (String)

      An optional description of your CEV.

    • Status — (String)

      The availability status to be assigned to the CEV. Valid values are as follows:

      available

      You can use this CEV to create a new RDS Custom DB instance.

      inactive

      You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.

      You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.

      Possible values include:
      • "available"
      • "inactive"
      • "inactive-except-restore"

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.

      • 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)

          A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

        • IsMajorVersionUpgrade — (Boolean)

          A value that indicates whether 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)

          A value that indicates whether you can use Aurora parallel query with the target engine version.

        • SupportsGlobalDatabases — (Boolean)

          A value that indicates whether you can use Aurora global databases with the target engine version.

      • 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)

        A value that 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)

        A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

      • SupportsGlobalDatabases — (Boolean)

        A value that 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}.:/=+\-@]*)$").

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBCluster(params = {}, callback) ⇒ AWS.Request

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the modifyDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  AllowMajorVersionUpgrade: true || false,
  ApplyImmediately: true || false,
  BacktrackWindow: 'NUMBER_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CloudwatchLogsExportConfiguration: {
    DisableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ],
    EnableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBInstanceParameterGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableGlobalWriteForwarding: true || false,
  EnableHttpEndpoint: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  NewDBClusterIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ScalingConfiguration: {
    AutoPause: true || false,
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE',
    SecondsBeforeTimeout: 'NUMBER_VALUE',
    SecondsUntilAutoPause: 'NUMBER_VALUE',
    TimeoutAction: 'STRING_VALUE'
  },
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

      Constraints: This identifier must match the identifier of an existing DB cluster.

    • NewDBClusterIdentifier — (String)

      The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens

      • The first character must be a letter

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • ApplyImmediately — (Boolean)

      A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

      The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

      By default, this parameter is disabled.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to use for the DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the DB cluster will belong to.

    • Port — (Integer)

      The port number on which the DB cluster accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB cluster.

    • MasterUserPassword — (String)

      The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • OptionGroupName — (String)

      A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    • 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. 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, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    • BacktrackWindow — (Integer)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    • CloudwatchLogsExportConfiguration — (map)

      The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

      • EnableLogTypes — (Array<String>)

        The list of log types to enable.

      • DisableLogTypes — (Array<String>)

        The list of log types to disable.

    • EngineVersion — (String)

      The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

      To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      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"

    • AllowMajorVersionUpgrade — (Boolean)

      A value that indicates whether major version upgrades are allowed.

      Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

    • DBInstanceParameterGroupName — (String)

      The name of the DB parameter group to apply to all instances of the DB cluster.

      Note: When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

      Default: The existing name setting

      Constraints:

      • The DB parameter group must be in the same DB parameter group family as this DB cluster.

      • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

    • Domain — (String)

      The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

      For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

    • ScalingConfiguration — (map)

      The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

      • 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)

        A value that 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 from finding a scaling point might be dropped.

        For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

      • SecondsBeforeTimeout — (Integer)

        The amount of time, in seconds, that Aurora Serverless 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • EnableHttpEndpoint — (Boolean)

      A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

      When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

      For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

    • EnableGlobalWriteForwarding — (Boolean)

      A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.

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.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBClusterEndpoint(params = {}, callback) ⇒ AWS.Request

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the modifyDBClusterEndpoint operation

var params = {
  DBClusterEndpointIdentifier: 'STRING_VALUE', /* required */
  EndpointType: 'STRING_VALUE',
  ExcludedMembers: [
    'STRING_VALUE',
    /* more items */
  ],
  StaticMembers: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBClusterEndpoint(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 of the endpoint to modify. 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. Only relevant if the list of static members is empty.

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.

modifyDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

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 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 action to verify that your DB cluster parameter group has been created or modified.

If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the modifyDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [ /* required */
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE',
      SupportedEngineModes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
rds.modifyDBClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to modify.

    • Parameters — (Array<map>)

      A list of parameters in the DB cluster parameter group to modify.

      Valid Values (for the application method): immediate | pending-reboot

      Note: You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters. When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"
      • SupportedEngineModes — (Array<String>)

        The valid DB engine modes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        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

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBClusterSnapshotAttribute(params = {}, callback) ⇒ AWS.Request

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.

Note: Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the modifyDBClusterSnapshotAttribute operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  ValuesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  ValuesToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBClusterSnapshotAttribute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier for the DB cluster snapshot to modify the attributes for.

    • AttributeName — (String)

      The name of the DB cluster snapshot attribute to modify.

      To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

      Note: To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API action.
    • ValuesToAdd — (Array<String>)

      A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    • ValuesToRemove — (Array<String>)

      A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBClusterSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

        Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • DBClusterSnapshotIdentifier — (String)

          The identifier of the manual DB cluster snapshot that the attributes apply to.

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB cluster snapshot.

          • AttributeName — (String)

            The name of the manual DB cluster snapshot attribute.

            The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value(s) for the manual DB cluster snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBInstance(params = {}, callback) ⇒ AWS.Request

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Service Reference:

Examples:

Calling the modifyDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AllowMajorVersionUpgrade: true || false,
  ApplyImmediately: true || false,
  AutoMinorVersionUpgrade: true || false,
  AutomationMode: full | all-paused,
  AwsBackupRecoveryPointArn: 'STRING_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CACertificateIdentifier: 'STRING_VALUE',
  CertificateRotationRestart: true || false,
  CloudwatchLogsExportConfiguration: {
    DisableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ],
    EnableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CopyTagsToSnapshot: true || false,
  DBInstanceClass: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBPortNumber: 'NUMBER_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCustomerOwnedIp: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  NewDBInstanceIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  PerformanceInsightsRetentionPeriod: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ProcessorFeatures: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PromotionTier: 'NUMBER_VALUE',
  PubliclyAccessible: true || false,
  ReplicaMode: open-read-only | mounted,
  ResumeFullAutomationModeMinutes: 'NUMBER_VALUE',
  StorageType: 'STRING_VALUE',
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  UseDefaultProcessorFeatures: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBInstanceIdentifier — (String)

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • AllocatedStorage — (Integer)

      The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

      For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      For the valid values for allocated storage for each engine, see CreateDBInstance.

    • DBInstanceClass — (String)

      The new compute and memory capacity of the DB instance, 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.

      If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

      This setting doesn't apply to RDS Custom.

      Default: Uses existing setting

    • DBSubnetGroupName — (String)

      The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

      Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

      This parameter doesn't apply to RDS Custom.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetGroup

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match existing DBSecurityGroups.

    • VpcSecurityGroupIds — (Array<String>)

      A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      This setting doesn't apply to RDS Custom.

      Amazon Aurora

      Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Constraints:

      • If supplied, must match existing VpcSecurityGroupIds.

    • ApplyImmediately — (Boolean)

      A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

      If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

    • MasterUserPassword — (String)

      The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

      Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

      This setting doesn't apply to RDS Custom.

      Amazon Aurora

      Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

      Default: Uses existing setting

      MariaDB

      Constraints: Must contain from 8 to 41 characters.

      Microsoft SQL Server

      Constraints: Must contain from 8 to 128 characters.

      MySQL

      Constraints: Must contain from 8 to 41 characters.

      Oracle

      Constraints: Must contain from 8 to 30 characters.

      PostgreSQL

      Constraints: Must contain from 8 to 128 characters.

      Note: Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
    • DBParameterGroupName — (String)

      The name of the DB parameter group to apply to the DB instance.

      Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.

      This setting doesn't apply to RDS Custom.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

    • BackupRetentionPeriod — (Integer)

      The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

      Note: Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

      These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

      Amazon Aurora

      Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Default: Uses existing setting

      Constraints:

      • It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.

      • It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.

      • It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. 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.

      Amazon Aurora

      Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi

      • Must be in Universal Time Coordinated (UTC)

      • Must not conflict with the preferred maintenance window

      • Must be at least 30 minutes

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

    • MultiAZ — (Boolean)

      A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

      This setting doesn't apply to RDS Custom.

    • EngineVersion — (String)

      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

      For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

      If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

      In RDS Custom, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.

    • AllowMajorVersionUpgrade — (Boolean)

      A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

      This setting doesn't apply to RDS Custom.

      Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:

      • The automatic upgrade is enabled for the maintenance window.

      • A newer minor version is available.

      • RDS has enabled automatic patching for the engine version.

      If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.

      For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.

    • LicenseModel — (String)

      The license model for the DB instance.

      This setting doesn't apply to RDS Custom.

      Valid values: license-included | bring-your-own-license | general-public-license

    • Iops — (Integer)

      The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

      Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

      Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

      Default: Uses existing setting

    • OptionGroupName — (String)

      A value that indicates the DB instance should be associated with the specified option group.

      Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.

      The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and 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 RDS Custom.

    • NewDBInstanceIdentifier — (String)

      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Example: mydbinstance

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

      If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

      Valid values: standard | gp2 | io1

      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 RDS Custom.

    • 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.

    • CACertificateIdentifier — (String)

      Specifies the certificate to associate with the DB instance.

      This setting doesn't apply to RDS Custom.

    • Domain — (String)

      The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only 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 RDS Custom.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

      Amazon Aurora

      Not applicable. 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 ModifyDBCluster.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

      If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

      This setting doesn't apply to RDS Custom.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

    • DBPortNumber — (Integer)

      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.

      This setting doesn't apply to RDS Custom.

      MySQL

      Default: 3306

      Valid values: 1150-65535

      MariaDB

      Default: 3306

      Valid values: 1150-65535

      PostgreSQL

      Default: 5432

      Valid values: 1150-65535

      Type: Integer

      Oracle

      Default: 1521

      Valid values: 1150-65535

      SQL Server

      Default: 1433

      Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

      Amazon Aurora

      Default: 3306

      Valid values: 1150-65535

    • PubliclyAccessible — (Boolean)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

      PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      This setting doesn't apply to RDS Custom.

    • 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 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, supply a MonitoringRoleArn value.

      This setting doesn't apply to RDS Custom.

    • 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.

    • 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.

      This setting doesn't apply to RDS Custom.

      Default: 1

      Valid Values: 0 - 15

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

      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.

    • EnablePerformanceInsights — (Boolean)

      A value that indicates whether to enable Performance Insights for the DB instance.

      For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

      This setting doesn't apply to RDS Custom.

    • 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.

    • PerformanceInsightsRetentionPeriod — (Integer)

      The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

      This setting doesn't apply to RDS Custom.

    • CloudwatchLogsExportConfiguration — (map)

      The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

      A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

      This setting doesn't apply to RDS Custom.

      • EnableLogTypes — (Array<String>)

        The list of log types to enable.

      • DisableLogTypes — (Array<String>)

        The list of log types to disable.

    • 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.

      • 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)

      A value that indicates whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    • 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 RDS Custom.

    • CertificateRotationRestart — (Boolean)

      A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.

      By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

      Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

      If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

      This setting doesn't apply to RDS Custom.

    • ReplicaMode — (String)

      A value that sets the open mode of a replica database to either mounted or read-only.

      Note: Currently, this parameter is only supported for Oracle DB instances.

      Mounted DB replicas are included in Oracle 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. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

      This setting doesn't apply to RDS Custom.

      Possible values include:
      • "open-read-only"
      • "mounted"
    • EnableCustomerOwnedIp — (Boolean)

      A value that indicates 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.

    • AwsBackupRecoveryPointArn — (String)

      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

      This setting doesn't apply to RDS Custom.

    • 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 ResumeFullAutomationModeMinutes.

      Possible values include:
      • "full"
      • "all-paused"
    • ResumeFullAutomationModeMinutes — (Integer)

      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.

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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

After you modify 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 modify 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 modifyDBParameterGroup operation

var params = {
  DBParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [ /* required */
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE',
      SupportedEngineModes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
rds.modifyDBParameterGroup(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:

      • If supplied, must match the name of an existing DBParameterGroup.

    • Parameters — (Array<map>)

      An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

      Valid Values (for the application method): immediate | pending-reboot

      Note: You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters. When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"
      • SupportedEngineModes — (Array<String>)

        The valid DB engine modes.

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:

      • DBParameterGroupName — (String)

        The name of the DB parameter group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBProxy(params = {}, callback) ⇒ AWS.Request

Changes the settings for an existing DB proxy.

Service Reference:

Examples:

Calling the modifyDBProxy operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  Auth: [
    {
      AuthScheme: SECRETS,
      Description: 'STRING_VALUE',
      IAMAuth: DISABLED | REQUIRED,
      SecretArn: 'STRING_VALUE',
      UserName: 'STRING_VALUE'
    },
    /* more items */
  ],
  DebugLogging: true || false,
  IdleClientTimeout: 'NUMBER_VALUE',
  NewDBProxyName: 'STRING_VALUE',
  RequireTLS: true || false,
  RoleArn: 'STRING_VALUE',
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBProxy(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 DBProxy to modify.

    • NewDBProxyName — (String)

      The new identifier for the DBProxy. 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.

    • Auth — (Array<map>)

      The new authentication settings for the DBProxy.

      • 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.

        Possible values include:
        • "DISABLED"
        • "REQUIRED"
    • RequireTLS — (Boolean)

      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, even if the associated database doesn't use TLS.

    • 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)

      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.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

    • SecurityGroups — (Array<String>)

      The new list of security groups for the DBProxy.

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 object representing the new settings for the 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 engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

        • 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.

            Possible values include:
            • "DISABLED"
            • "REQUIRED"
        • 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)

          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.

modifyDBProxyEndpoint(params = {}, callback) ⇒ AWS.Request

Changes the settings for an existing DB proxy endpoint.

Service Reference:

Examples:

Calling the modifyDBProxyEndpoint operation

var params = {
  DBProxyEndpointName: 'STRING_VALUE', /* required */
  NewDBProxyEndpointName: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBProxyEndpoint(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 sociated with the DB proxy endpoint that you want to modify.

    • NewDBProxyEndpointName — (String)

      The new identifier for the DBProxyEndpoint. 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.

    • VpcSecurityGroupIds — (Array<String>)

      The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.

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 representing the new settings for the DB proxy endpoint.

        • 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)

          A value that 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.

modifyDBProxyTargetGroup(params = {}, callback) ⇒ AWS.Request

Modifies the properties of a DBProxyTargetGroup.

Service Reference:

Examples:

Calling the modifyDBProxyTargetGroup operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  TargetGroupName: 'STRING_VALUE', /* required */
  ConnectionPoolConfig: {
    ConnectionBorrowTimeout: 'NUMBER_VALUE',
    InitQuery: 'STRING_VALUE',
    MaxConnectionsPercent: 'NUMBER_VALUE',
    MaxIdleConnectionsPercent: 'NUMBER_VALUE',
    SessionPinningFilters: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  NewName: 'STRING_VALUE'
};
rds.modifyDBProxyTargetGroup(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: {}) —
    • TargetGroupName — (String)

      The name of the new target group to assign to the proxy.

    • DBProxyName — (String)

      The name of the new proxy to which to assign the target group.

    • ConnectionPoolConfig — (map)

      The settings that determine the size and behavior of the connection pool for the target group.

      • MaxConnectionsPercent — (Integer)

        The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

        Default: 100

        Constraints: between 1 and 100

      • MaxIdleConnectionsPercent — (Integer)

        Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

        Default: 50

        Constraints: between 0 and MaxConnectionsPercent

      • ConnectionBorrowTimeout — (Integer)

        The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

        Default: 120

        Constraints: between 1 and 3600, or 0 representing unlimited

      • SessionPinningFilters — (Array<String>)

        Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

        Default: no session pinning filters

      • InitQuery — (String)

        One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

        Default: no initialization query

    • NewName — (String)

      The new name for the modified DBProxyTarget. 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.

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:

      • DBProxyTargetGroup — (map)

        The settings of the modified DBProxyTarget.

        • DBProxyName — (String)

          The identifier for the RDS proxy associated with this target group.

        • TargetGroupName — (String)

          The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

        • TargetGroupArn — (String)

          The Amazon Resource Name (ARN) representing the target group.

        • IsDefault — (Boolean)

          Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

        • Status — (String)

          The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

        • ConnectionPoolConfig — (map)

          The settings that determine the size and behavior of the connection pool for the target group.

          • MaxConnectionsPercent — (Integer)

            The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

          • MaxIdleConnectionsPercent — (Integer)

            Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

          • ConnectionBorrowTimeout — (Integer)

            The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

          • SessionPinningFilters — (Array<String>)

            Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

          • InitQuery — (String)

            One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

        • CreatedDate — (Date)

          The date and time when the target group was first created.

        • UpdatedDate — (Date)

          The date and time when the target group was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBSnapshot(params = {}, callback) ⇒ AWS.Request

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the modifyDBSnapshot operation

var params = {
  DBSnapshotIdentifier: 'STRING_VALUE', /* required */
  EngineVersion: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE'
};
rds.modifyDBSnapshot(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 of the DB snapshot to modify.

    • EngineVersion — (String)

      The engine version to upgrade the DB snapshot to.

      The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

      MySQL

      • 5.5.46 (supported for 5.1 DB snapshots)

      Oracle

      • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

      • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

      • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

      PostgreSQL

      For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.

    • OptionGroupName — (String)

      The option group to identify with the upgraded DB snapshot.

      You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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)

          Specifies 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBSnapshotAttribute(params = {}, callback) ⇒ AWS.Request

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

Note: Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.

Service Reference:

Examples:

Calling the modifyDBSnapshotAttribute operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  DBSnapshotIdentifier: 'STRING_VALUE', /* required */
  ValuesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  ValuesToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyDBSnapshotAttribute(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 to modify the attributes for.

    • AttributeName — (String)

      The name of the DB snapshot attribute to modify.

      To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

      Note: To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API action.
    • ValuesToAdd — (Array<String>)

      A list of DB snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.

    • ValuesToRemove — (Array<String>)

      A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

        Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

        • DBSnapshotIdentifier — (String)

          The identifier of the manual DB snapshot that the attributes apply to.

        • DBSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB snapshot.

          • AttributeName — (String)

            The name of the manual DB snapshot attribute.

            The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value or values for the manual DB snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyDBSubnetGroup(params = {}, callback) ⇒ AWS.Request

Modifies an existing 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 modifyDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupDescription: 'STRING_VALUE'
};
rds.modifyDBSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBSubnetGroupName — (String)

      The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the DB subnet group.

    • SubnetIds — (Array<String>)

      The EC2 subnet IDs for the DB subnet group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBSubnetGroup — (map)

        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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyEventSubscription(params = {}, callback) ⇒ AWS.Request

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Service Reference:

Examples:

Calling the modifyEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  SnsTopicArn: 'STRING_VALUE',
  SourceType: 'STRING_VALUE'
};
rds.modifyEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the RDS event notification subscription.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. 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

    • EventCategories — (Array<String>)

      A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

    • Enabled — (Boolean)

      A value that indicates whether to activate the subscription.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventSubscription — (map)

        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)

          A Boolean value indicating if 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.

modifyGlobalCluster(params = {}, callback) ⇒ AWS.Request

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the modifyGlobalCluster operation

var params = {
  AllowMajorVersionUpgrade: true || false,
  DeletionProtection: true || false,
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE',
  NewGlobalClusterIdentifier: 'STRING_VALUE'
};
rds.modifyGlobalCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalClusterIdentifier — (String)

      The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing global database cluster.

    • NewGlobalClusterIdentifier — (String)

      The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens

      • The first character must be a letter

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • DeletionProtection — (Boolean)

      Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

    • EngineVersion — (String)

      The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

      To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == true].[EngineVersion]'

      To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == true].[EngineVersion]'

      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 '*[]|[?SupportsGlobalDatabases == true].[EngineVersion]'

    • AllowMajorVersionUpgrade — (Boolean)

      A value that indicates whether major version upgrades are allowed.

      Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

      If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Aurora cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

          • IsWriter — (Boolean)

            Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyOptionGroup(params = {}, callback) ⇒ AWS.Request

Modifies an existing option group.

Service Reference:

Examples:

Calling the modifyOptionGroup operation

var params = {
  OptionGroupName: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  OptionsToInclude: [
    {
      OptionName: 'STRING_VALUE', /* required */
      DBSecurityGroupMemberships: [
        'STRING_VALUE',
        /* more items */
      ],
      OptionSettings: [
        {
          AllowedValues: 'STRING_VALUE',
          ApplyType: 'STRING_VALUE',
          DataType: 'STRING_VALUE',
          DefaultValue: 'STRING_VALUE',
          Description: 'STRING_VALUE',
          IsCollection: true || false,
          IsModifiable: true || false,
          Name: 'STRING_VALUE',
          Value: 'STRING_VALUE'
        },
        /* more items */
      ],
      OptionVersion: 'STRING_VALUE',
      Port: 'NUMBER_VALUE',
      VpcSecurityGroupMemberships: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  OptionsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.modifyOptionGroup(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 modified.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    • OptionsToInclude — (Array<map>)

      Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

      • OptionName — required — (String)

        The configuration of options to include in a group.

      • Port — (Integer)

        The optional port for the option.

      • OptionVersion — (String)

        The version for the option.

      • DBSecurityGroupMemberships — (Array<String>)

        A list of DBSecurityGroupMembership name strings used for this option.

      • VpcSecurityGroupMemberships — (Array<String>)

        A list of VpcSecurityGroupMembership name strings used for this option.

      • OptionSettings — (Array<map>)

        The option settings to include in an option group.

        • 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)

          A Boolean value that, when true, indicates the option setting can be modified from the default.

        • IsCollection — (Boolean)

          Indicates if the option setting is part of a collection.

    • OptionsToRemove — (Array<String>)

      Options in this list are removed from the option group.

    • ApplyImmediately — (Boolean)

      A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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)

            Indicate if this option is persistent.

          • Permanent — (Boolean)

            Indicate if 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)

              A Boolean value that, when true, indicates the option setting can be modified from the default.

            • IsCollection — (Boolean)

              Indicates if 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 status of the VPC security group.

        • 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)

          The Amazon Resource Name (ARN) for the option group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

promoteReadReplica(params = {}, callback) ⇒ AWS.Request

Promotes a read replica DB instance to a standalone DB instance.

Note:
  • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
  • This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

Service Reference:

Examples:

Calling the promoteReadReplica operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  BackupRetentionPeriod: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE'
};
rds.promoteReadReplica(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. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing read replica DB instance.

      Example: mydbinstance

    • 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.

      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.

    • 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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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.

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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

promoteReadReplicaDBCluster(params = {}, callback) ⇒ AWS.Request

Promotes a read replica DB cluster to a standalone DB cluster.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the promoteReadReplicaDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
rds.promoteReadReplicaDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB cluster read replica.

      Example: my-cluster-replica1

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBCluster — (map)

        Contains the details of an Amazon Aurora DB cluster.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

purchaseReservedDBInstancesOffering(params = {}, callback) ⇒ AWS.Request

Purchases a reserved DB instance offering.

Service Reference:

Examples:

Calling the purchaseReservedDBInstancesOffering operation

var params = {
  ReservedDBInstancesOfferingId: 'STRING_VALUE', /* required */
  DBInstanceCount: 'NUMBER_VALUE',
  ReservedDBInstanceId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.purchaseReservedDBInstancesOffering(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: {}) —
    • ReservedDBInstancesOfferingId — (String)

      The ID of the Reserved DB instance offering to purchase.

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    • ReservedDBInstanceId — (String)

      Customer-specified identifier to track this reservation.

      Example: myreservationID

    • DBInstanceCount — (Integer)

      The number of instances to reserve.

      Default: 1

    • 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:

      • ReservedDBInstance — (map)

        This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

        • ReservedDBInstanceId — (String)

          The unique identifier for the reservation.

        • ReservedDBInstancesOfferingId — (String)

          The offering identifier.

        • DBInstanceClass — (String)

          The DB instance class for the reserved DB instance.

        • StartTime — (Date)

          The time the reservation started.

        • Duration — (Integer)

          The duration of the reservation in seconds.

        • FixedPrice — (Float)

          The fixed price charged for this reserved DB instance.

        • UsagePrice — (Float)

          The hourly price charged for this reserved DB instance.

        • CurrencyCode — (String)

          The currency code for the reserved DB instance.

        • DBInstanceCount — (Integer)

          The number of reserved DB instances.

        • ProductDescription — (String)

          The description of the reserved DB instance.

        • OfferingType — (String)

          The offering type of this reserved DB instance.

        • MultiAZ — (Boolean)

          Indicates if the reservation applies to Multi-AZ deployments.

        • State — (String)

          The state of the reserved DB instance.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved DB instance.

          • RecurringChargeAmount — (Float)

            The amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

        • ReservedDBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the reserved DB instance.

        • LeaseId — (String)

          The unique identifier for the lease associated with the reserved DB instance.

          Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rebootDBInstance(params = {}, callback) ⇒ AWS.Request

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the rebootDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  ForceFailover: true || false
};
rds.rebootDBInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBInstanceIdentifier — (String)

      The DB instance identifier. This parameter is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • ForceFailover — (Boolean)

      A value that indicates whether the reboot is conducted through a Multi-AZ failover.

      Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerDBProxyTargets(params = {}, callback) ⇒ AWS.Request

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Service Reference:

Examples:

Calling the registerDBProxyTargets operation

var params = {
  DBProxyName: 'STRING_VALUE', /* required */
  DBClusterIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  DBInstanceIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  TargetGroupName: 'STRING_VALUE'
};
rds.registerDBProxyTargets(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. The data object has the following properties:

      • DBProxyTargets — (Array<map>)

        One or more DBProxyTarget objects that are created when you register targets with a target group.

        • TargetArn — (String)

          The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

        • Endpoint — (String)

          The writer endpoint for the RDS DB instance or Aurora DB cluster.

        • TrackedClusterId — (String)

          The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

        • RdsResourceId — (String)

          The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.

        • Port — (Integer)

          The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

        • Type — (String)

          Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

          Possible values include:
          • "RDS_INSTANCE"
          • "RDS_SERVERLESS_ENDPOINT"
          • "TRACKED_CLUSTER"
        • Role — (String)

          A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

          Possible values include:
          • "READ_WRITE"
          • "READ_ONLY"
          • "UNKNOWN"
        • TargetHealth — (map)

          Information about the connection health of the RDS Proxy target.

          • State — (String)

            The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

            registering > unavailable > available > unavailable > available

            Possible values include:
            • "REGISTERING"
            • "AVAILABLE"
            • "UNAVAILABLE"
          • Reason — (String)

            The reason for the current health State of the RDS Proxy target.

            Possible values include:
            • "UNREACHABLE"
            • "CONNECTION_FAILED"
            • "AUTH_FAILURE"
            • "PENDING_PROXY_CAPACITY"
            • "INVALID_REPLICATION_STATE"
          • Description — (String)

            A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeFromGlobalCluster(params = {}, callback) ⇒ AWS.Request

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the removeFromGlobalCluster operation

var params = {
  DbClusterIdentifier: 'STRING_VALUE',
  GlobalClusterIdentifier: 'STRING_VALUE'
};
rds.removeFromGlobalCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalClusterIdentifier — (String)

      The cluster identifier to detach from the Aurora global database cluster.

    • DbClusterIdentifier — (String)

      The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database 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 cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

          • DBClusterArn — (String)

            The Amazon Resource Name (ARN) for each Aurora cluster.

          • Readers — (Array<String>)

            The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

          • IsWriter — (Boolean)

            Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

          • GlobalWriteForwardingStatus — (String)

            Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
            • "unknown"
        • FailoverState — (map)

          A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

          • Status — (String)

            The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

            • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

            • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

            • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeRoleFromDBCluster(params = {}, callback) ⇒ AWS.Request

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the removeRoleFromDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  FeatureName: 'STRING_VALUE'
};
rds.removeRoleFromDBCluster(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 disassociate the IAM role from.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role to disassociate from 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 disassociated from. 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.

removeRoleFromDBInstance(params = {}, callback) ⇒ AWS.Request

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

Service Reference:

Examples:

Calling the removeRoleFromDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  FeatureName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE' /* required */
};
rds.removeRoleFromDBInstance(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 disassociate the IAM role from.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role to disassociate from 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 disassociated from. 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.

removeSourceIdentifierFromSubscription(params = {}, callback) ⇒ AWS.Request

Removes a source identifier from an existing RDS event notification subscription.

Service Reference:

Examples:

Calling the removeSourceIdentifierFromSubscription operation

var params = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
rds.removeSourceIdentifierFromSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the RDS event notification subscription you want to remove a source identifier from.

    • SourceIdentifier — (String)

      The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventSubscription — (map)

        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)

          A Boolean value indicating if 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.

removeTagsFromResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
rds.removeTagsFromResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceName — (String)

      The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    • TagKeys — (Array<String>)

      The tag key (name) of the tag to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resetDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the resetDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE',
      SupportedEngineModes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
rds.resetDBClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to reset.

    • ResetAllParameters — (Boolean)

      A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

    • Parameters — (Array<map>)

      A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"
      • SupportedEngineModes — (Array<String>)

        The valid DB engine modes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        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

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resetDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

Service Reference:

Examples:

Calling the resetDBParameterGroup operation

var params = {
  DBParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE',
      SupportedEngineModes: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
rds.resetDBParameterGroup(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 match the name of an existing DBParameterGroup.

    • ResetAllParameters — (Boolean)

      A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

    • Parameters — (Array<map>)

      To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

      MySQL

      Valid Values (for Apply method): immediate | pending-reboot

      You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

      MariaDB

      Valid Values (for Apply method): immediate | pending-reboot

      You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

      Oracle

      Valid Values (for Apply method): pending-reboot

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        Possible values include:
        • "immediate"
        • "pending-reboot"
      • SupportedEngineModes — (Array<String>)

        The valid DB engine modes.

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:

      • DBParameterGroupName — (String)

        The name of the DB parameter group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBClusterFromS3(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

Note: This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

Service Reference:

Examples:

Calling the restoreDBClusterFromS3 operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  MasterUserPassword: 'STRING_VALUE', /* required */
  MasterUsername: 'STRING_VALUE', /* required */
  S3BucketName: 'STRING_VALUE', /* required */
  S3IngestionRoleArn: 'STRING_VALUE', /* required */
  SourceEngine: 'STRING_VALUE', /* required */
  SourceEngineVersion: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BacktrackWindow: 'NUMBER_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  S3Prefix: 'STRING_VALUE',
  StorageEncrypted: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBClusterFromS3(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 instances in the restored DB cluster can be created.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • CharacterSetName — (String)

      A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

    • DatabaseName — (String)

      The database name for the restored DB cluster.

    • DBClusterIdentifier — (String)

      The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to associate with the restored DB cluster.

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with the restored DB cluster.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • Engine — (String)

      The name of the database engine to be used for this DB cluster.

      Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

    • EngineVersion — (String)

      The version number of the database engine to use.

      To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      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"

      Aurora MySQL

      Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

      Aurora PostgreSQL

      Example: 9.6.3, 10.7

    • Port — (Integer)

      The port number on which the instances in the restored DB cluster accept connections.

      Default: 3306

    • MasterUsername — (String)

      The name of the master user for the restored DB cluster.

      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. This password can contain any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • OptionGroupName — (String)

      A value that indicates that the restored DB cluster should be associated with the specified option group.

      Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

    • 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. 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, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • 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}.:/=+\-@]*)$").

    • StorageEncrypted — (Boolean)

      A value that indicates whether the restored DB cluster is encrypted.

    • 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.

      If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    • SourceEngine — (String)

      The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

      Valid values: mysql

    • SourceEngineVersion — (String)

      The version of the database that the backup files were created from.

      MySQL versions 5.5, 5.6, and 5.7 are supported.

      Example: 5.6.40, 5.7.28

    • S3BucketName — (String)

      The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

    • S3Prefix — (String)

      The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

    • S3IngestionRoleArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

    • BacktrackWindow — (Integer)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      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 logs that the restored DB cluster 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 Aurora User Guide.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    • Domain — (String)

      Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

      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.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

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.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBClusterFromSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.

The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

Note: This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the restoreDBClusterFromSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BacktrackWindow: 'NUMBER_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EngineMode: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  ScalingConfiguration: {
    AutoPause: true || false,
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE',
    SecondsBeforeTimeout: 'NUMBER_VALUE',
    SecondsUntilAutoPause: 'NUMBER_VALUE',
    TimeoutAction: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBClusterFromSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZones — (Array<String>)

      Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

    • DBClusterIdentifier — (String)

      The name of the DB cluster to create from the DB snapshot or 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-snapshot-id

    • SnapshotIdentifier — (String)

      The identifier for the DB snapshot or DB cluster snapshot to restore from.

      You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

      Constraints:

      • Must match the identifier of an existing Snapshot.

    • Engine — (String)

      The database engine to use for the new DB cluster.

      Default: The same as source

      Constraint: Must be compatible with the engine of the source

    • EngineVersion — (String)

      The version of the database engine to use for the new DB cluster.

      To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      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"

      Note: If you aren't using the default engine version, then you must specify the engine version.

      Aurora MySQL

      Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

      Aurora PostgreSQL

      Example: 9.6.3, 10.7

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: This value must be 1150-65535

      Default: The same port as the original DB cluster.

    • DBSubnetGroupName — (String)

      The name of the DB subnet group to use for the new DB cluster.

      Constraints: If supplied, must match the name of an existing DB subnet group.

      Example: mySubnetgroup

    • DatabaseName — (String)

      The database name for the restored DB cluster.

    • OptionGroupName — (String)

      The name of the option group to use for the restored DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the new DB cluster will belong to.

    • Tags — (Array<map>)

      The tags to be assigned to the restored DB cluster.

      • 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}.:/=+\-@]*)$").

    • KmsKeyId — (String)

      The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      When you don't specify a value for the KmsKeyId parameter, then the following occurs:

      • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

      • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    • BacktrackWindow — (Integer)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      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 logs that the restored DB cluster is to export to Amazon 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 Aurora User Guide.

    • EngineMode — (String)

      The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

      For more information, see CreateDBCluster.

    • ScalingConfiguration — (map)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      • 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)

        A value that 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 from finding a scaling point might be dropped.

        For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

      • SecondsBeforeTimeout — (Integer)

        The amount of time, in seconds, that Aurora Serverless 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.

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

      Constraints:

      • If supplied, must match the name of an existing default DB cluster parameter group.

      • 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    • Domain — (String)

      Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. 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.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

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.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBClusterToPointInTime(params = {}, callback) ⇒ AWS.Request

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

Note: This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the restoreDBClusterToPointInTime operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  SourceDBClusterIdentifier: 'STRING_VALUE', /* required */
  BacktrackWindow: 'NUMBER_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EngineMode: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  RestoreToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RestoreType: 'STRING_VALUE',
  ScalingConfiguration: {
    AutoPause: true || false,
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE',
    SecondsBeforeTimeout: 'NUMBER_VALUE',
    SecondsUntilAutoPause: 'NUMBER_VALUE',
    TimeoutAction: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseLatestRestorableTime: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBClusterToPointInTime(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      The name of the new DB cluster to be created.

      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

    • RestoreType — (String)

      The type of restore to be performed. You can specify one of the following values:

      • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

      • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

      Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

      If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

    • SourceDBClusterIdentifier — (String)

      The identifier of the source DB cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • RestoreToTime — (Date)

      The date and time to restore the DB cluster to.

      Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

      Constraints:

      • Must be before the latest restorable time for the DB instance

      • Must be specified if UseLatestRestorableTime parameter isn't provided

      • Can't be specified if the UseLatestRestorableTime parameter is enabled

      • Can't be specified if the RestoreType parameter is copy-on-write

      Example: 2015-03-07T23:45:00Z

    • UseLatestRestorableTime — (Boolean)

      A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

      Constraints: Can't be specified if RestoreToTime parameter is provided.

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: A value from 1150-65535.

      Default: The default port for the engine.

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new DB cluster.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • OptionGroupName — (String)

      The name of the option group for the new DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the new DB cluster belongs to.

    • 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}.:/=+\-@]*)$").

    • KmsKeyId — (String)

      The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from 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.

      You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

      If you don't specify a value for the KmsKeyId parameter, then the following occurs:

      • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

      • If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

      If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    • BacktrackWindow — (Integer)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      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 logs that the restored DB cluster 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 Aurora User Guide.

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

      Constraints:

      • If supplied, must match the name of an existing DB cluster parameter group.

      • 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    • Domain — (String)

      Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

      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.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

    • ScalingConfiguration — (map)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      • 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)

        A value that 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 from finding a scaling point might be dropped.

        For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

      • SecondsBeforeTimeout — (Integer)

        The amount of time, in seconds, that Aurora Serverless 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.

    • EngineMode — (String)

      The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DBCluster — (map)

        Contains the details of an Amazon Aurora DB cluster.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBInstanceFromDBSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Note: This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

Service Reference:

Examples:

Calling the restoreDBInstanceFromDBSnapshot operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  DBSnapshotIdentifier: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  CustomIamInstanceProfile: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableCustomerOwnedIp: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  Engine: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  LicenseModel: 'STRING_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  ProcessorFeatures: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PubliclyAccessible: true || false,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  UseDefaultProcessorFeatures: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBInstanceFromDBSnapshot(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)

      Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

      Constraints:

      • Must contain from 1 to 63 numbers, letters, or hyphens

      • First character must be a letter

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

    • DBSnapshotIdentifier — (String)

      The identifier for the DB snapshot to restore from.

      Constraints:

      • Must match the identifier of an existing DBSnapshot.

      • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    • DBInstanceClass — (String)

      The compute and memory capacity of the Amazon RDS DB instance, 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: The same DBInstanceClass as the original DB instance.

    • Port — (Integer)

      The port number on which the database accepts connections.

      Default: The same port as the original DB instance

      Constraints: Value must be 1150-65535

    • AvailabilityZone — (String)

      The Availability Zone (AZ) where the DB instance will be created.

      Default: A random, system-chosen Availability Zone.

      Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      Example: us-east-1a

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new instance.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • MultiAZ — (Boolean)

      A value that indicates whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

      Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    • PubliclyAccessible — (Boolean)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

      For more information, see CreateDBInstance.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

      If you restore an RDS Custom DB instance, you must disable this parameter.

    • LicenseModel — (String)

      License model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Default: Same as source.

      Valid values: license-included | bring-your-own-license | general-public-license

    • DBName — (String)

      The database name for the restored DB instance.

      This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.

    • Engine — (String)

      The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      Default: The same as source

      Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

      Valid Values:

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • Iops — (Integer)

      Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

      The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

      Constraints: Must be an integer greater than 1000.

    • OptionGroupName — (String)

      The name of the option group to be used for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and 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 RDS Custom.

    • 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}.:/=+\-@]*)$").

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      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 RDS Custom.

    • 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.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

    • Domain — (String)

      Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only 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 RDS Custom.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

      This setting doesn't apply to RDS Custom.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      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.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of logs that the restored 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.

    • 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.

      • 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)

      A value that indicates whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

    • 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 RDS uses the default DBParameterGroup for the specified DB engine.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

      • 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    • EnableCustomerOwnedIp — (Boolean)

      A value that indicates 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.

      This setting doesn't apply to RDS Custom.

      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. 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 Relational Database Service User Guide.

      This setting is required for 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:

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBInstanceFromS3(params = {}, callback) ⇒ AWS.Request

Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the restoreDBInstanceFromS3 operation

var params = {
  DBInstanceClass: 'STRING_VALUE', /* required */
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  S3BucketName: 'STRING_VALUE', /* required */
  S3IngestionRoleArn: 'STRING_VALUE', /* required */
  SourceEngine: 'STRING_VALUE', /* required */
  SourceEngineVersion: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CopyTagsToSnapshot: true || false,
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  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 */
  ],
  PubliclyAccessible: true || false,
  S3Prefix: 'STRING_VALUE',
  StorageEncrypted: true || false,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseDefaultProcessorFeatures: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBInstanceFromS3(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 name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

    • DBInstanceIdentifier — (String)

      The DB instance identifier. 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 gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

      Note: Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
    • DBInstanceClass — (String)

      The compute and memory capacity of the DB instance, 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.

      Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

    • Engine — (String)

      The name of the database engine to be used for this instance.

      Valid Values: mysql

    • MasterUsername — (String)

      The name for the master user.

      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 user. The password can include any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to associate with this DB instance.

      Default: The default DB security group for the database engine.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups to associate with this DB instance.

    • AvailabilityZone — (String)

      The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

      Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

      Example: us-east-1d

      Constraint: 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.

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB instance.

    • PreferredMaintenanceWindow — (String)

      The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

      Constraints:

      • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

      • Valid Days: 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 do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

    • PreferredBackupWindow — (String)

      The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS 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.

    • Port — (Integer)

      The port number on which the database accepts connections.

      Type: Integer

      Valid Values: 1150-65535

      Default: 3306

    • MultiAZ — (Boolean)

      A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

    • EngineVersion — (String)

      The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

    • LicenseModel — (String)

      The license model for this DB instance. Use general-public-license.

    • Iops — (Integer)

      The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

    • OptionGroupName — (String)

      The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

    • PubliclyAccessible — (Boolean)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

      For more information, see CreateDBInstance.

    • Tags — (Array<map>)

      A list of tags to associate with this DB instance. 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}.:/=+\-@]*)$").

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      Default: io1 if the Iops parameter is specified; otherwise gp2

    • StorageEncrypted — (Boolean)

      A value that indicates whether the new DB instance is encrypted or not.

    • 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.

      If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      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.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    • SourceEngine — (String)

      The name of the engine of your source database.

      Valid Values: mysql

    • SourceEngineVersion — (String)

      The version of the database that the backup files were created from.

      MySQL versions 5.6 and 5.7 are supported.

      Example: 5.6.40

    • S3BucketName — (String)

      The name of your Amazon S3 bucket that contains your database backup file.

    • S3Prefix — (String)

      The prefix of your Amazon S3 bucket.

    • S3IngestionRoleArn — (String)

      An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

    • EnablePerformanceInsights — (Boolean)

      A value that indicates whether to enable Performance Insights for the DB instance.

      For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

    • 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.

    • PerformanceInsightsRetentionPeriod — (Integer)

      The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of logs that the restored 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.

    • 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.

    • UseDefaultProcessorFeatures — (Boolean)

      A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    • 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.

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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreDBInstanceToPointInTime(params = {}, callback) ⇒ AWS.Request

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

Note: This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

Service Reference:

Examples:

Calling the restoreDBInstanceToPointInTime operation

var params = {
  TargetDBInstanceIdentifier: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  CustomIamInstanceProfile: 'STRING_VALUE',
  DBInstanceClass: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableCustomerOwnedIp: true || false,
  EnableIAMDatabaseAuthentication: true || false,
  Engine: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  LicenseModel: 'STRING_VALUE',
  MaxAllocatedStorage: 'NUMBER_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  ProcessorFeatures: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PubliclyAccessible: true || false,
  RestoreTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  SourceDBInstanceAutomatedBackupsArn: 'STRING_VALUE',
  SourceDBInstanceIdentifier: 'STRING_VALUE',
  SourceDbiResourceId: 'STRING_VALUE',
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  UseDefaultProcessorFeatures: true || false,
  UseLatestRestorableTime: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
rds.restoreDBInstanceToPointInTime(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: {}) —
    • SourceDBInstanceIdentifier — (String)

      The identifier of the source DB instance from which to restore.

      Constraints:

      • Must match the identifier of an existing DB instance.

    • TargetDBInstanceIdentifier — (String)

      The name of the new DB instance to be created.

      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

    • RestoreTime — (Date)

      The date and time to restore from.

      Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

      Constraints:

      • Must be before the latest restorable time for the DB instance

      • Can't be specified if the UseLatestRestorableTime parameter is enabled

      Example: 2009-09-07T23:45:00Z

    • UseLatestRestorableTime — (Boolean)

      A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

      Constraints: Can't be specified if the RestoreTime parameter is provided.

    • DBInstanceClass — (String)

      The compute and memory capacity of the Amazon RDS DB instance, 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: The same DBInstanceClass as the original DB instance.

    • Port — (Integer)

      The port number on which the database accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB instance.

    • AvailabilityZone — (String)

      The Availability Zone (AZ) where the DB instance will be created.

      Default: A random, system-chosen Availability Zone.

      Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

      Example: us-east-1a

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new instance.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • MultiAZ — (Boolean)

      A value that indicates whether the DB instance is a Multi-AZ deployment.

      This setting doesn't apply to RDS Custom.

      Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    • PubliclyAccessible — (Boolean)

      A value that indicates whether the DB instance is publicly accessible.

      When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

      For more information, see CreateDBInstance.

    • AutoMinorVersionUpgrade — (Boolean)

      A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

      This setting doesn't apply to RDS Custom.

    • LicenseModel — (String)

      License model information for the restored DB instance.

      This setting doesn't apply to RDS Custom.

      Default: Same as source.

      Valid values: license-included | bring-your-own-license | general-public-license

    • DBName — (String)

      The database name for the restored DB instance.

      Note: This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
    • Engine — (String)

      The database engine to use for the new instance.

      This setting doesn't apply to RDS Custom.

      Default: The same as source

      Constraint: Must be compatible with the engine of the source

      Valid Values:

      • mariadb

      • mysql

      • oracle-ee

      • oracle-ee-cdb

      • oracle-se2

      • oracle-se2-cdb

      • postgres

      • sqlserver-ee

      • sqlserver-se

      • sqlserver-ex

      • sqlserver-web

    • Iops — (Integer)

      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

      Constraints: Must be an integer greater than 1000.

      SQL Server

      Setting the IOPS value for the SQL Server database engine isn't supported.

    • OptionGroupName — (String)

      The name of the option group to be used for the restored DB instance.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and 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 RDS Custom.

    • CopyTagsToSnapshot — (Boolean)

      A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. 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}.:/=+\-@]*)$").

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      Valid values: standard | gp2 | io1

      If you specify io1, you must also include a value for the Iops parameter.

      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 RDS Custom.

    • 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.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to associate with this DB instance.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

    • Domain — (String)

      Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

      This setting doesn't apply to RDS Custom.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

      This setting doesn't apply to RDS Custom.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

      This setting doesn't apply to RDS Custom.

      For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of logs that the restored 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.

    • 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.

      • 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)

      A value that indicates whether the DB instance class of the DB instance uses its default processor features.

      This setting doesn't apply to RDS Custom.

    • DBParameterGroupName — (String)

      The name of the DB parameter group to associate with this DB instance.

      If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

      This setting doesn't apply to RDS Custom.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

      • 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.

    • DeletionProtection — (Boolean)

      A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    • SourceDbiResourceId — (String)

      The resource ID of the source DB instance from which to restore.

    • 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 RDS Custom.

    • SourceDBInstanceAutomatedBackupsArn — (String)

      The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

    • EnableCustomerOwnedIp — (Boolean)

      A value that indicates 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.

      This setting doesn't apply to RDS Custom.

      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. 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 Relational Database Service User Guide.

      This setting is required for 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:

      • DBInstance — (map)

        Contains the details of an Amazon RDS DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

revokeDBSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

Service Reference:

Examples:

Calling the revokeDBSecurityGroupIngress operation

var params = {
  DBSecurityGroupName: 'STRING_VALUE', /* required */
  CIDRIP: 'STRING_VALUE',
  EC2SecurityGroupId: 'STRING_VALUE',
  EC2SecurityGroupName: 'STRING_VALUE',
  EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
rds.revokeDBSecurityGroupIngress(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 revoke ingress from.

    • CIDRIP — (String)

      The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.

    • EC2SecurityGroupName — (String)

      The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    • EC2SecurityGroupId — (String)

      The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    • EC2SecurityGroupOwnerId — (String)

      The 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)

            Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

          • CIDRIP — (String)

            Specifies 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.

startActivityStream(params = {}, callback) ⇒ AWS.Request

Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Service Reference:

Examples:

Calling the startActivityStream operation

var params = {
  KmsKeyId: 'STRING_VALUE', /* required */
  Mode: sync | async, /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  EngineNativeAuditFieldsIncluded: true || false
};
rds.startActivityStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    • Mode — (String)

      Specifies 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"
    • KmsKeyId — (String)

      The Amazon Web Services KMS key identifier 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.

    • ApplyImmediately — (Boolean)

      Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

    • EngineNativeAuditFieldsIncluded — (Boolean)

      Specifies whether the database activity stream includes engine-native audit fields. This option only applies to an Oracle DB instance. By default, no engine-native audit fields are included.

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:

      • KmsKeyId — (String)

        The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

      • KinesisStreamName — (String)

        The name of the Amazon Kinesis data stream to be used for the database activity stream.

      • Status — (String)

        The status of the database activity stream.

        Possible values include:
        • "stopped"
        • "starting"
        • "started"
        • "stopping"
      • Mode — (String)

        The mode of the database activity stream.

        Possible values include:
        • "sync"
        • "async"
      • ApplyImmediately — (Boolean)

        Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

      • EngineNativeAuditFieldsIncluded — (Boolean)

        Indicates whether engine-native audit fields are included in the database activity stream.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startDBCluster(params = {}, callback) ⇒ AWS.Request

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the startDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
rds.startDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      The DB cluster identifier of the Amazon Aurora DB cluster to be started. 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:

      • DBCluster — (map)

        Contains the details of an Amazon Aurora DB cluster.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startDBInstance(params = {}, callback) ⇒ AWS.Request

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

Note: This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

Service Reference:

Examples:

Calling the startDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE' /* required */
};
rds.startDBInstance(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 instance identifier.

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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startDBInstanceAutomatedBackupsReplication(params = {}, callback) ⇒ AWS.Request

Enables replication of automated backups to a different Amazon Web Services Region.

This command doesn't apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the startDBInstanceAutomatedBackupsReplication operation

var params = {
  SourceDBInstanceArn: 'STRING_VALUE', /* required */
  BackupRetentionPeriod: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE'
};
rds.startDBInstanceAutomatedBackupsReplication(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: {}) —
    • SourceDBInstanceArn — (String)

      The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

    • BackupRetentionPeriod — (Integer)

      The retention period for the replicated automated backups.

    • KmsKeyId — (String)

      The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

    • PreSignedUrl — (String)

      A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be called in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API action that can be executed in the Amazon Web Services Region that contains the source 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:

      • 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 identifier 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 customer id of the instance that is/was associated with the automated backup.

        • 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.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Provides 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)

          Provides the VPC ID associated with the DB instance

        • InstanceCreateTime — (Date)

          Provides the date and time that the DB instance was created.

        • MasterUsername — (String)

          The license model 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)

          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)

          Specifies whether the automated backup is encrypted.

        • StorageType — (String)

          Specifies 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startExportTask(params = {}, callback) ⇒ AWS.Request

Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.

This command doesn't apply to RDS Custom.

Service Reference:

Examples:

Calling the startExportTask operation

var params = {
  ExportTaskIdentifier: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE', /* required */
  S3BucketName: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  ExportOnly: [
    'STRING_VALUE',
    /* more items */
  ],
  S3Prefix: 'STRING_VALUE'
};
rds.startExportTask(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)

      A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.

    • SourceArn — (String)

      The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

    • S3BucketName — (String)

      The name of the Amazon S3 bucket to export the snapshot to.

    • IamRoleArn — (String)

      The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.

    • KmsKeyId — (String)

      The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy:

      • GrantOperation.Encrypt

      • GrantOperation.Decrypt

      • GrantOperation.GenerateDataKey

      • GrantOperation.GenerateDataKeyWithoutPlaintext

      • GrantOperation.ReEncryptFrom

      • GrantOperation.ReEncryptTo

      • GrantOperation.CreateGrant

      • GrantOperation.DescribeKey

      • GrantOperation.RetireGrant

    • S3Prefix — (String)

      The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

    • ExportOnly — (Array<String>)

      The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:

      • database - Export all the data from a specified database.

      • database.table table-name - Export a table of the snapshot. 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. 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.

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 export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.

      • SourceArn — (String)

        The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

      • ExportOnly — (Array<String>)

        The data exported from the snapshot. Valid values are the following:

        • database - Export all the data from a specified database.

        • database.table table-name - Export a table of the snapshot. 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. 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 that the snapshot was created.

      • TaskStartTime — (Date)

        The time that the snapshot export task started.

      • TaskEndTime — (Date)

        The time that the snapshot export task completed.

      • S3Bucket — (String)

        The Amazon S3 bucket that the snapshot is exported to.

      • S3Prefix — (String)

        The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

      • IamRoleArn — (String)

        The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

      • KmsKeyId — (String)

        The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot 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 snapshot export must have encryption and decryption permissions to use this KMS key.

      • Status — (String)

        The progress status of the export task.

      • PercentProgress — (Integer)

        The progress of the snapshot 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 export task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopActivityStream(params = {}, callback) ⇒ AWS.Request

Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.

For more information, see Database Activity Streams in the Amazon Aurora User Guide.

Service Reference:

Examples:

Calling the stopActivityStream operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false
};
rds.stopActivityStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    • ApplyImmediately — (Boolean)

      Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

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:

      • KmsKeyId — (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.

      • KinesisStreamName — (String)

        The name of the Amazon Kinesis data stream used for the database activity stream.

      • Status — (String)

        The status of the database activity stream.

        Possible values include:
        • "stopped"
        • "starting"
        • "started"
        • "stopping"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopDBCluster(params = {}, callback) ⇒ AWS.Request

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Note: This action only applies to Aurora DB clusters.

Service Reference:

Examples:

Calling the stopDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
rds.stopDBCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBClusterIdentifier — (String)

      The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. 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:

      • DBCluster — (map)

        Contains the details of an Amazon Aurora DB cluster.

        This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

        • 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>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

        • BackupRetentionPeriod — (Integer)

          Specifies 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)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • AutomaticRestartTime — (Date)

          The time when a stopped DB cluster is restarted automatically.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          The earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the 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>)

          Identifies all custom endpoints associated with the cluster.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          The name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Contains the identifier of the source 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.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • 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>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the 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>)

          Provides 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)

          A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.

          For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

        • EngineMode — (String)

          The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

          For more information, see CreateDBCluster.

        • ScalingConfigurationInfo — (map)

          Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

          For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

          • MinCapacity — (Integer)

            The maximum capacity for the 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)

            A value that 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 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 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.

        • DeletionProtection — (Boolean)

          Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        • HttpEndpointEnabled — (Boolean)

          A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

          When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

          For more information, see Using the Data API for Aurora Serverless 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)

          Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

        • CrossAccountClone — (Boolean)

          Specifies 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • 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)

          Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
          • "unknown"
        • GlobalWriteForwardingRequested — (Boolean)

          Specifies whether you have requested to enable write forwarding 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)

          A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. 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)

            A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

          • EngineVersion — (String)

            The database engine version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopDBInstance(params = {}, callback) ⇒ AWS.Request

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

Note: This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Service Reference:

Examples:

Calling the stopDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  DBSnapshotIdentifier: 'STRING_VALUE'
};
rds.stopDBInstance(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 instance identifier.

    • DBSnapshotIdentifier — (String)

      The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

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 DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopDBInstanceAutomatedBackupsReplication(params = {}, callback) ⇒ AWS.Request

Stops automated backup replication for a DB instance.

This command doesn't apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the stopDBInstanceAutomatedBackupsReplication operation

var params = {
  SourceDBInstanceArn: 'STRING_VALUE' /* required */
};
rds.stopDBInstanceAutomatedBackupsReplication(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: {}) —
    • SourceDBInstanceArn — (String)

      The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

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 identifier 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 customer id of the instance that is/was associated with the automated backup.

        • 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.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Provides 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)

          Provides the VPC ID associated with the DB instance

        • InstanceCreateTime — (Date)

          Provides the date and time that the DB instance was created.

        • MasterUsername — (String)

          The license model 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)

          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)

          Specifies whether the automated backup is encrypted.

        • StorageType — (String)

          Specifies 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given RDS resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

rds.waitFor('dBInstanceAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

      • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

rds.waitFor('dBInstanceDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceDeleted state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBInstanceDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

      • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          The name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies 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)

          Contains the master username for the DB instance.

        • DBName — (String)

          The meaning of this parameter differs according to the database engine you use.

          MySQL, MariaDB, SQL Server, PostgreSQL

          Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

          Type: String

          Oracle

          Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

        • Endpoint — (map)

          Specifies the connection endpoint.

          Note: The endpoint might not be shown for instances whose status is 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)

          Specifies the allocated storage size specified in gibibytes (GiB).

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic 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>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides 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)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on 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.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. 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)

            A value that indicates that 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.

          • 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)

            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.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          A value that indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a read replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the read replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not 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)

          License model information for this DB instance. This setting doesn't apply to RDS Custom.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides 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)

          Specifies the accessibility options for the DB instance.

          When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.

          For more information, see CreateDBInstance.

        • StatusInfos — (Array<map>)

          The status of a read replica. If the instance isn't a read replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the 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)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies 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, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB instance is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, 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.

        • 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 of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

          Amazon Aurora

          Not applicable. 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)

          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.

        • 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

          IAM database authentication can be enabled for the following database engines

          • For MySQL 5.6, minor version 5.6.34 or higher

          • For MySQL 5.7, minor version 5.7.16 or higher

          • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • 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 amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

        • 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 Amazon RDS Database 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 if 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)

            Describes 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)

          Specifies 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)

          Specifies 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 Relational Database Service User Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

rds.waitFor('dBSnapshotAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshots() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBSnapshotAvailable state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBSnapshotAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • DBSnapshotIdentifier — (String)

      A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • SnapshotType — (String)

      The type of snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

      • public - Return all DB snapshots that have been marked as public.

      • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

        For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

        The awsbackup type does not apply to Aurora.

      If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

      This setting doesn't apply to RDS Custom.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

      This setting doesn't apply to RDS Custom.

    • DbiResourceId — (String)

      A specific DB resource ID to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBSnapshots — (Array<map>)

        A list of DBSnapshot instances.

        • 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)

          Specifies 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

rds.waitFor('dBSnapshotDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshots() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBSnapshotDeleted state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBSnapshotDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • DBSnapshotIdentifier — (String)

      A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • SnapshotType — (String)

      The type of snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

      • public - Return all DB snapshots that have been marked as public.

      • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

        For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

        The awsbackup type does not apply to Aurora.

      If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

      This setting doesn't apply to RDS Custom.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

      This setting doesn't apply to RDS Custom.

    • DbiResourceId — (String)

      A specific DB resource ID to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBSnapshots — (Array<map>)

        A list of DBSnapshot instances.

        • 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)

          Specifies 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

rds.waitFor('dBClusterSnapshotAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBClusterSnapshotAvailable state by periodically calling the underlying RDS.describeDBClusterSnapshots() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBClusterSnapshotAvailable state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBClusterSnapshotAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBClusterIdentifier — (String)

      The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBCluster.

    • DBClusterSnapshotIdentifier — (String)

      A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBClusterSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • SnapshotType — (String)

      The type of DB cluster snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

      • public - Return all DB cluster snapshots that have been marked as public.

      If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      A filter that specifies one or more DB cluster snapshots to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

      • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

      • snapshot-type - Accepts types of DB cluster snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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 DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterSnapshots — (Array<map>)

        Provides a list of DB cluster snapshots for the user.

        • AvailabilityZones — (Array<String>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine for this DB cluster snapshot.

        • EngineMode — (String)

          Provides the engine mode of the database engine for this DB cluster snapshot.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • 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.

See Also:

rds.waitFor('dBClusterSnapshotDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBClusterSnapshotDeleted state by periodically calling the underlying RDS.describeDBClusterSnapshots() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBClusterSnapshotDeleted state

var params = {
  // ... input parameters ...
};
rds.waitFor('dBClusterSnapshotDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBClusterIdentifier — (String)

      The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBCluster.

    • DBClusterSnapshotIdentifier — (String)

      A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBClusterSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • SnapshotType — (String)

      The type of DB cluster snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

      • public - Return all DB cluster snapshots that have been marked as public.

      If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      A filter that specifies one or more DB cluster snapshots to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

      • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

      • snapshot-type - Accepts types of DB cluster snapshots.

      • engine - Accepts names of database engines.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Values — required — (Array<String>)

        One or more filter values. Filter values are case-sensitive.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

    • IncludePublic — (Boolean)

      A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

      You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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 DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterSnapshots — (Array<map>)

        Provides a list of DB cluster snapshots for the user.

        • AvailabilityZones — (Array<String>)

          Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine for this DB cluster snapshot.

        • EngineMode — (String)

          Provides the engine mode of the database engine for this DB cluster snapshot.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for this DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies 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)

          True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • 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.

See Also: