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.

Sending a Request Using RDS

var rds = new AWS.RDS();
rds.addRoleToDBCluster(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

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Service Reference:

Examples:

Calling the addRoleToDBCluster operation

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

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

Examples:

Calling the addSourceIdentifierToSubscription operation

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

Parameters:

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

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

    • SourceIdentifier — (String)

      The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

      Constraints:

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

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

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

      • If the source type is a DB snapshot, a DBSnapshotIdentifier 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 AWS 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 the tags will be 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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

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

          • AutoAppliedAfterDate — (Date)

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

          • ForcedApplyDate — (Date)

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

          • OptInStatus — (String)

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

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action will be 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 cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot 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)

      AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not 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 result of a successful invocation of the following actions:

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

        • OwnerId — (String)

          Provides the AWS 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 AWS 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.

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

Copies the specified DB cluster parameter group.

Service Reference:

Examples:

Calling the copyDBClusterParameterGroup operation

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

      Constraints:

      • Must specify a valid DB cluster parameter group.

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

      • If the source DB parameter group is in a different region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

    • TargetDBClusterParameterGroupIdentifier — (String)

      The identifier for the copied DB cluster parameter group.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-cluster-param-group1

    • TargetDBClusterParameterGroupDescription — (String)

      A description for the copied DB cluster parameter group.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.

        This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

        • DBClusterParameterGroupName — (String)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides 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 AWS region. In that case, the region where you call the CopyDBClusterSnapshot action is the destination region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another region, you must provide the following values:

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

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

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

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the region that the DB cluster snapshot will 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 region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination 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 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 region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the copyDBClusterSnapshot operation

var params = {
  SourceDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  SourceRegion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
rds.copyDBClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

      You cannot copy an encrypted, shared DB cluster snapshot from one AWS region to another.

      Constraints:

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

      • First character must be a letter.

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

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

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

      • If the source snapshot is in a different region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.

      Example: my-cluster-snapshot1

    • TargetDBClusterSnapshotIdentifier — (String)

      The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

      Constraints:

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

      • First character must be a letter.

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

      Example: my-cluster-snapshot2

    • KmsKeyId — (String)

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

      If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.

      If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the 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 AWS account, then you must specify a value for KmsKeyId.

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

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS 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 AWS region.

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

      • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.

      • DestinationRegion - The name of the region that the DB cluster snapshot will 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 region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

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

      True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the following actions:

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

        • AvailabilityZones — (Array<String>)

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

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

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 RDS Amazon Resource Name (ARN).

      Constraints:

      • Must specify a valid DB parameter group.

      • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

    • TargetDBParameterGroupIdentifier — (String)

      The identifier for the copied DB parameter group.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

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

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the CreateDBParameterGroup action.

        This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

        • DBParameterGroupName — (String)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

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

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

You can copy an encrypted DB snapshot from another AWS region. In that case, the region where you call the CopyDBSnapshot action is the destination region for the encrypted DB snapshot to be copied to. To copy an encrypted DB snapshot from another region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBSnapshot action to be called in the source region where the DB snapshot will be copied from. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source region that contains the encrypted DB snapshot to be copied.

    The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the encrypted DB snapshot will be copied to. This 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 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This identifier is the same for both the CopyDBSnapshot action that is called in the destination 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 region. For example, if you copy an encrypted DB snapshot from the us-west-2 region, then your SourceDBSnapshotIdentifier looks like this 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBSnapshotIdentifier - The identifier for the new copy of the DB snapshot in the destination region.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the ARN format for the source region and is the same value as the SourceDBSnapshotIdentifier in the presigned URL.

For more information on copying encrypted snapshots from one region to another, 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',
  PreSignedUrl: 'STRING_VALUE',
  SourceRegion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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 you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

      You cannot copy an encrypted, shared DB snapshot from one AWS region to another.

      Constraints:

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

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

      • If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.

      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 copied snapshot.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-db-snapshot

    • KmsKeyId — (String)

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

      If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

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

      If you copy an encrypted snapshot to a different AWS region, then you must specify a KMS key for the destination AWS region.

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

      To copy an encrypted DB snapshot to another region, you must set KmsKeyId to the KMS key ID used to encrypt the copy of the DB snapshot in the destination region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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)

      True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the AWS region that contains the source DB snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB snapshot from another AWS region.

      The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

      • DestinationRegion - The AWS Region that the encrypted DB snapshot will be copied to. This 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 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

      • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination 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 region. For example, if you are copying an encrypted DB snapshot from the us-west-2 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

      Note: If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
    • 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 result of a successful invocation of the following actions:

        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)

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

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 when the snapshot was taken, in Universal Coordinated Time (UTC).

        • 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 region that the DB snapshot was created in or copied from.

        • SourceDBSnapshotIdentifier — (String)

          The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer 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 KMS key identifier for the encrypted DB snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

  • (AWS.Request)

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

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

Copies the specified option group.

Service Reference:

Examples:

Calling the copyOptionGroup operation

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

Parameters:

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

      The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

      Constraints:

      • Must specify a valid option group.

      • If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

      • If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

    • TargetOptionGroupIdentifier — (String)

      The identifier for the copied option group.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

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

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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.

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 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BackupRetentionPeriod: 0,
  CharacterSetName: 'STRING_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PreSignedUrl: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ReplicationSourceIdentifier: '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 EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

    • 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

    • 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 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not 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 alphanumeric characters or hyphens.

      • First character must be a letter.

      • Cannot 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 this argument is omitted, default.aurora5.6 will be used.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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 contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

      Example: mySubnetgroup

    • Engine — (String)

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

      Valid Values: aurora

    • EngineVersion — (String)

      The version number of the database engine to use.

      Aurora

      Example: 5.6.10a

    • Port — (Integer)

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

      Default: 3306

    • MasterUsername — (String)

      The name of the master user for the DB cluster.

      Constraints:

      • Must be 1 to 16 alphanumeric characters.

      • First character must be a letter.

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

    • MasterUserPassword — (String)

      The password for the master database user. This password can contain any printable ASCII character except "/", """, 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 cannot be removed from an option group. The option group cannot 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.

      Default: A 30-minute window selected at random from an 8-hour block of time per 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.

      • Times should 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

      Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • StorageEncrypted — (Boolean)

      Specifies whether the DB cluster is encrypted.

    • KmsKeyId — (String)

      The KMS key identifier for an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

      If you create a Read Replica of an encrypted DB cluster in another region, you must set KmsKeyId to a KMS key ID that is valid in the destination region. This key is used to encrypt the Read Replica in that region.

    • PreSignedUrl — (String)

      A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source region where the DB cluster will be 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 region that contains the encrypted DB cluster to be copied.

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

      • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination region, and the action contained in the pre-signed URL.

      • DestinationRegion - The name of the 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 region. For example, if you are copying an encrypted DB cluster from the us-west-2 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

      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 Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • 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 result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBClusterParameterGroup operation

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

Parameters:

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

      The name of the DB cluster parameter group.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Note: This value is stored as a lowercase string.
    • 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.

    • Description — (String)

      The description for the DB cluster parameter group.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.

        This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

        • DBClusterParameterGroupName — (String)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the createDBClusterSnapshot operation

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

Parameters:

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

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

      Constraints:

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

      • First character must be a letter.

      • Cannot 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 is not case-sensitive.

      Constraints:

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

      • First character must be a letter.

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

      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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the following actions:

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

        • AvailabilityZones — (Array<String>)

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

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

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: 0,
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  BackupRetentionPeriod: 0,
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterIdentifier: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 0,
  KmsKeyId: 'STRING_VALUE',
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MonitoringInterval: 0,
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 0,
  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.

      Type: String

      MySQL

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

      Constraints:

      • Must contain 1 to 64 alphanumeric characters

      • Cannot 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 is not specified, no database is created in the DB instance.

      Constraints:

      • Must contain 1 to 64 alphanumeric characters

      • Cannot 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 is not specified, the default "postgres" database is created in the DB instance.

      Constraints:

      • Must contain 1 to 63 alphanumeric characters

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

      • Cannot be a word reserved by the specified database engine

      Oracle

      The Oracle System ID (SID) of the created DB instance.

      Default: ORCL

      Constraints:

      • Cannot be longer than 8 characters

      SQL Server

      Not applicable. Must be null.

      Amazon Aurora

      The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

      Constraints:

      • Must contain 1 to 64 alphanumeric characters

      • Cannot be a word reserved by the specified database engine

    • DBInstanceIdentifier — (String)

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

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).

      • First character must be a letter.

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

      Example: mydbinstance

    • AllocatedStorage — (Integer)

      The amount of storage (in gigabytes) to be initially allocated for the database 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.

      MySQL

      Constraints: Must be an integer from 5 to 6144.

      MariaDB

      Constraints: Must be an integer from 5 to 6144.

      PostgreSQL

      Constraints: Must be an integer from 5 to 6144.

      Oracle

      Constraints: Must be an integer from 10 to 6144.

      SQL Server

      Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

    • DBInstanceClass — (String)

      The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines.

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

    • Engine — (String)

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

      Valid Values: mysql | mariadb | oracle-se1 | oracle-se2 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

      Not every database engine is available for every AWS region.

    • MasterUsername — (String)

      The name for the master database user.

      Amazon Aurora

      Not applicable. You specify the name for the master database user when you create your DB cluster.

      MariaDB

      Constraints:

      • Must be 1 to 16 alphanumeric characters.

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

      Microsoft SQL Server

      Constraints:

      • Must be 1 to 128 alphanumeric characters.

      • First character must be a letter.

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

      MySQL

      Constraints:

      • Must be 1 to 16 alphanumeric characters.

      • First character must be a letter.

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

      Oracle

      Constraints:

      • Must be 1 to 30 alphanumeric characters.

      • First character must be a letter.

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

      PostgreSQL

      Constraints:

      • Must be 1 to 63 alphanumeric characters.

      • First character must be a letter.

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

    • MasterUserPassword — (String)

      The password for the master database user. Can be any printable ASCII character except "/", """, or "@".

      Amazon Aurora

      Not applicable. You specify the password for the master database user when you create your 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 EC2 VPC security groups to associate with this DB instance.

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

    • AvailabilityZone — (String)

      The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

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

      Example: us-east-1d

      Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

    • 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 weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.

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

      Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

      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 this argument is omitted, the default DBParameterGroup for the specified engine will be used.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

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

      Default: 1

      Constraints:

      • Must be a value from 0 to 35

      • Cannot 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. For more information, see DB Instance Backups.

      Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.

      Constraints:

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

      • Times should 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 for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

      Type: Integer

    • MultiAZ — (Boolean)

      Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    • EngineVersion — (String)

      The version number of the database engine to use.

      The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

      Amazon Aurora

      • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1, us-east-2, us-west-2): 5.6.10a

      MariaDB

      • Version 10.1 (available in these AWS regions: us-east-2): 10.1.16

      • Version 10.1 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 10.1.14

      • Version 10.0 (available in all AWS regions): 10.0.24

      • Version 10.0 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 10.0.17

      Microsoft SQL Server 2016

      • 13.00.2164.0.v1 (supported for all editions, and all AWS regions except sa-east-1)

      Microsoft SQL Server 2014

      • 12.00.5000.0.v1 (supported for all editions, and all AWS regions)

      • 12.00.4422.0.v1 (supported for all editions except Enterprise Edition, and all AWS regions except us-east-2)

      Microsoft SQL Server 2012

      • 11.00.6020.0.v1 (supported for all editions, and all AWS regions)

      • 11.00.5058.0.v1 (supported for all editions, and all AWS regions except us-east-2)

      • 11.00.2100.60.v1 (supported for all editions, and all AWS regions except us-east-2)

      Microsoft SQL Server 2008 R2

      • 10.50.6529.0.v1 (supported for all editions, and all AWS regions except us-east-2)

      • 10.50.6000.34.v1 (supported for all editions, and all AWS regions except us-east-2)

      • 10.50.2789.0.v1 (supported for all editions, and all AWS regions except us-east-2)

      MySQL

      • Version 5.7 (available in all AWS regions): 5.7.11

      • Version 5.7 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.7.10

      • Version 5.6 (available in all AWS regions): 5.6.29

      • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.27

      • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.23

      • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22

      • Version 5.5 (available in all AWS regions): 5.5.46

      • Version 5.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b

      Oracle 12c

      • 12.1.0.2.v7 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v6 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v5 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v4 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v3 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v2 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      • 12.1.0.2.v1 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

      Oracle 11g

      • 11.2.0.4.v11 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v10 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v9 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v8 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v7 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v6 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v5 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v4 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v3 (supported for EE, SE1, and SE, in all AWS regions)

      • 11.2.0.4.v1 (supported for EE, SE1, and SE, in all AWS regions)

      PostgreSQL

      • Version 9.6: 9.6.1

      • Version 9.5: 9.5.4 | 9.5.2

      • Version 9.4: 9.4.9 | 9.4.7 | 9.4.5 | 9.4.4 | 9.4.1

      • Version 9.3: 9.3.14 | 9.3.12 | 9.3.10 | 9.3.9 | 9.3.6 | 9.3.5 | 9.3.3 | 9.3.2 | 9.3.1

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

      Default: true

    • LicenseModel — (String)

      License model information for this DB instance.

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

    • Iops — (Integer)

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

      Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.

    • OptionGroupName — (String)

      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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    • CharacterSetName — (String)

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

    • PubliclyAccessible — (Boolean)

      Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

      • Default VPC: true

      • VPC: false

      If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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.

      For information on creating a DB cluster, see CreateDBCluster.

      Type: String

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

    • TdeCredentialArn — (String)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the Key Store in order to access the device.

    • StorageEncrypted — (Boolean)

      Specifies whether the DB instance is encrypted.

      Default: false

    • KmsKeyId — (String)

      The KMS key identifier for an encrypted DB instance.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

      If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

    • Domain — (String)

      Specify the Active Directory Domain to create the instance in.

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

    • 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. The default is 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

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring.

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

    • DomainIAMRoleName — (String)

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

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

      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)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

      You can enable IAM database authentication 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

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

      • DBInstance — (map)

        Contains the result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

Returns:

  • (AWS.Request)

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

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

Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

Note: Amazon Aurora does not support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created as Single-AZ deployments 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 below.

The source DB instance must have backup retention enabled.

You can create an encrypted Read Replica in a different AWS Region than the source DB instance. In that case, the region where you call the CreateDBInstanceReadReplica action is the destination region of the encrypted Read Replica. The source DB instance must be encrypted.

To create an encrypted Read Replica in another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the Read Replica in the destination region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

      For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.

    • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.

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

  • DBInstanceIdentifier - The identifier for the encrypted Read Replica in the destination region.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica. This identifier must be in the ARN format for the source region and is the same value as the SourceDBInstanceIdentifier in the presigned URL.

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,
  DBInstanceClass: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  Iops: 0,
  KmsKeyId: 'STRING_VALUE',
  MonitoringInterval: 0,
  MonitoringRoleArn: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PreSignedUrl: 'STRING_VALUE',
  PubliclyAccessible: true || false,
  SourceRegion: 'STRING_VALUE',
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: '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, or PostgreSQL DB instance.

      • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

      • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later.

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

      • If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.

      • If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

    • DBInstanceClass — (String)

      The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines.

      Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

      Default: Inherits from the source DB instance.

    • AvailabilityZone — (String)

      The Amazon EC2 Availability Zone that the Read Replica will be created in.

      Default: A random, system-chosen Availability Zone in the endpoint's 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

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

      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 will be associated with. If omitted, the default option group for the engine specified will be used.

    • PubliclyAccessible — (Boolean)

      Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

      • Default VPC:true

      • VPC:false

      If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

      Constraints:

      • Can only be specified if the source DB instance identifier specifies a DB instance in another region.

      • The specified DB subnet group must be in the same region in which the operation is running.

      • All Read Replicas in one region that are created from the same source DB instance must either:>

        • Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.

        • Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.

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

      Example: mySubnetgroup

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

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

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

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

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

    • KmsKeyId — (String)

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

      If you create an unencrypted Read Replica and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target Read Replica using the specified KMS encryption key.

      If you create an encrypted Read Replica from your AWS account, you can specify a value for KmsKeyId to encrypt the Read Replica with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the Read Replica is encrypted with the same KMS key as the source DB instance.

      If you create an encrypted Read Replica in a different AWS region, then you must specify a KMS key for the destination AWS region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

    • PreSignedUrl — (String)

      The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.

      The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:

      • DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

        For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

      • KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.

      • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.

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

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

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

      You can enable IAM database authentication 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.

      Default: false

    • 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 result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

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.

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 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Note: This value is stored as a lowercase string.
    • 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.

    • Description — (String)

      The description for the DB parameter group.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the CreateDBParameterGroup action.

        This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

        • DBParameterGroupName — (String)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

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

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

Creates a new DB security group. DB security groups control access to a DB instance.

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 alphanumeric characters

      • First character must be a letter

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

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the following actions:

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

        • OwnerId — (String)

          Provides the AWS 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 AWS 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 DBSnapshot. The source DBInstance must be in "available" 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:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

    • DBInstanceIdentifier — (String)

      The DB instance identifier. This is the unique key that identifies a DB instance.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the following actions:

        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)

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

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 when the snapshot was taken, in Universal Coordinated Time (UTC).

        • 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 region that the DB snapshot was created in or copied from.

        • SourceDBSnapshotIdentifier — (String)

          The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer 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 KMS key identifier for the encrypted DB snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

  • (AWS.Request)

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

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

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the 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 alphanumeric characters, 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>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 result of a successful invocation of the following actions:

        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)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Contains Availability Zone information.

            This data type is used as an element in the following data type:

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

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

Returns:

  • (AWS.Request)

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

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

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) 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) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

Service Reference:

Examples:

Calling the createEventSubscription operation

var params = {
  SnsTopicArn: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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 will be 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 is not 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 SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    • SourceIds — (Array<String>)

      The list of identifiers of the event sources for which events will be 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 cannot 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, then a DBInstanceIdentifier must be supplied.

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

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

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

    • Enabled — (Boolean)

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

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 AWS 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.

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

Creates a new option group. You can create up to 20 option groups.

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 alphanumeric characters or hyphens

      • First character must be a letter

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

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

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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.

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 cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • SkipFinalSnapshot — (Boolean)

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

      Note: You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

      Default: false

    • FinalDBSnapshotIdentifier — (String)

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

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

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBCluster — (map)

        Contains the result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 cannot be associated with any DB clusters.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBClusterParameterGroup operation

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

Parameters:

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

      The name of the DB cluster parameter group.

      Constraints:

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

      • You cannot delete a default DB cluster parameter group.

      • Cannot 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the deleteDBClusterSnapshot operation

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

Parameters:

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

      The identifier of the DB cluster snapshot to delete.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBClusterSnapshot — (map)

        Contains the result of a successful invocation of the following actions:

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

        • AvailabilityZones — (Array<String>)

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

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

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 cannot 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 cannot be canceled or reverted once submitted.

Note that 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 the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following 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 */
  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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • SkipFinalSnapshot — (Boolean)

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

      Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

      Specify true when deleting a Read Replica.

      Note: The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

      Default: false

    • FinalDBSnapshotIdentifier — (String)

      The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

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

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      • Cannot be specified when deleting a 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 result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

Returns:

  • (AWS.Request)

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

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

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot 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 cannot delete a default DB parameter group

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

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 cannot delete the default DB security group.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot 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 DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

Note: The DBSnapshot 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 DBSnapshot 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 result of a successful invocation of the following actions:

        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)

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

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 when the snapshot was taken, in Universal Coordinated Time (UTC).

        • 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 region that the DB snapshot was created in or copied from.

        • SourceDBSnapshotIdentifier — (String)

          The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer 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 KMS key identifier for the encrypted DB snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

  • (AWS.Request)

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

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

Deletes a DB subnet group.

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

Service Reference:

Examples:

Calling the deleteDBSubnetGroup operation

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

Parameters:

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

      The name of the database subnet group to delete.

      Note: You cannot delete the default subnet group.

      Constraints:

      Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. 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 AWS 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.

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

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 does not 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 AWS 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 AWS 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: 0
};
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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Certificates — (Array<map>)

        The list of Certificate objects for the AWS 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.

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

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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Examples:

Calling the describeDBClusterParameterGroups operation

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

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the describeDBClusterParameters operation

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

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Source — (String)

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

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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"
      • 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the describeDBClusters operation

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

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Filters — (Array<map>)

      A filter that specifies one or more DB clusters 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 clusters identified by these ARNs.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusters 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 subsequent 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 gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts.

To add or remove access for an AWS 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.

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 AWS 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 AWS 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 AWS 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 AWS 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

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: 0,
  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 cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • DBClusterSnapshotIdentifier — (String)

      A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

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

      • manual - Return all DB cluster snapshots that have been taken by my AWS account.

      • shared - Return all manual DB cluster snapshots that have been shared to my AWS 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 setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

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

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

    • IncludeShared — (Boolean)

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

      You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

    • IncludePublic — (Boolean)

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

      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 EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

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

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

  • (AWS.Request)

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

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

Returns a list of the available 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 */
  ],
  ListSupportedCharacterSets: true || false,
  ListSupportedTimezones: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 0
};
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.

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

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Filters — (Array<map>)

      Not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • 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 that the following results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

    • DefaultOnly — (Boolean)

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

    • ListSupportedCharacterSets — (Boolean)

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

    • ListSupportedTimezones — (Boolean)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

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

      • DBEngineVersions — (Array<map>)

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

          • 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 will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

          • IsMajorVersionUpgrade — (Boolean)

            A value that indicates whether a database engine will be upgraded to a major 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.

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.

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: 0
};
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:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

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

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

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.

Service Reference:

Examples:

Calling the describeDBLogFiles operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  FileLastWritten: 0,
  FileSize: 0,
  FilenameContains: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 0
};
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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

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

    • 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 subsequent 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: 0
};
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:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

          Provides 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: 0,
  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:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Source — (String)

      The parameter types to return.

      Default: All parameter types returned

      Valid Values: user | system | engine-default

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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"
      • 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: 0
};
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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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 AWS 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 AWS 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 AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts.

To add or remove access for an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublic: true || false,
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 0,
  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 cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • DBSnapshotIdentifier — (String)

      A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

      Constraints:

      • Must be 1 to 255 alphanumeric characters.

      • First character must be a letter.

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

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

      • manual - Return all DB snapshots that have been taken by my AWS account.

      • shared - Return all manual DB snapshots that have been shared to my AWS account.

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

      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 setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

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

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

    • IncludeShared — (Boolean)

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

      You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

    • IncludePublic — (Boolean)

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

      You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

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

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 when the snapshot was taken, in Universal Coordinated Time (UTC).

        • 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 region that the DB snapshot was created in or copied from.

        • SourceDBSnapshotIdentifier — (String)

          The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer 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 KMS key identifier for the encrypted DB snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

Returns:

  • (AWS.Request)

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

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: 0
};
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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Contains Availability Zone information.

            This data type is used as an element in the following data type:

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

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

Returns:

  • (AWS.Request)

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

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

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

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: 0
};
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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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"

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: 0
};
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>)

      Not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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"

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 the Events topic 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 will be generating the events.

      Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 0,
  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: 0,
  SourceIdentifier: 'STRING_VALUE',
  SourceType: db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
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 will be 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 DBInstance, then a DBInstanceIdentifier must be supplied.

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

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

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

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

    • SourceType — (String)

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

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

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. 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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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"
        • 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: 0,
  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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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 AWS 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.

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: 0
};
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 will be described.

    • MajorEngineVersion — (String)

      If specified, filters the results to include only options for the specified major engine version.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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.

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

        • 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; 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: 0,
  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. Cannot be supplied together with EngineName or MajorEngineVersion.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • 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 the remaining results can be retrieved.

      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.

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

Examples:

Calling the describeOrderableDBInstanceOptions operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  DBInstanceClass: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseModel: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 0,
  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.

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

    • Vpc — (Boolean)

      The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

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

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous 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 the orderable DB instance.

        • EngineVersion — (String)

          The engine version of the orderable DB instance.

        • DBInstanceClass — (String)

          The DB instance class for the orderable DB instance.

        • LicenseModel — (String)

          The license model for the orderable DB instance.

        • AvailabilityZones — (Array<map>)

          A list of Availability Zones for the orderable DB instance.

          • Name — (String)

            The name of the availability zone.

        • MultiAZCapable — (Boolean)

          Indicates whether this orderable DB instance is multi-AZ capable.

        • ReadReplicaCapable — (Boolean)

          Indicates whether this orderable DB instance can have a Read Replica.

        • Vpc — (Boolean)

          Indicates whether this is a VPC orderable DB instance.

        • SupportsStorageEncryption — (Boolean)

          Indicates whether this orderable DB instance supports encrypted storage.

        • StorageType — (String)

          Indicates the storage type for this orderable DB instance.

        • SupportsIops — (Boolean)

          Indicates whether this orderable DB instance supports provisioned IOPS.

        • SupportsEnhancedMonitoring — (Boolean)

          Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.

        • SupportsIAMDatabaseAuthentication — (Boolean)

          Indicates whether this orderable DB instance supports IAM database authentication.

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

Examples:

Calling the describePendingMaintenanceActions operation

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

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • 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 the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • PendingMaintenanceActions — (Array<map>)

        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.

          • AutoAppliedAfterDate — (Date)

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

          • ForcedApplyDate — (Date)

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

          • OptInStatus — (String)

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

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action will be 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 */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 0,
  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)

      The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • 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 that the following results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

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

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

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.

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: 0,
  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 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)

      The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

    • 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 that the following results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Marker — (String)

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

      • 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 AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot 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: 0,
  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 region name. For example, us-east-1.

      Constraints:

      • Must specify a valid AWS 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 that the remaining results can be retrieved.

      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 is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 AWS Region that the current region can get a Read Replica or a DB snapshot from.

        • RegionName — (String)

          The source region name.

        • Endpoint — (String)

          The source region endpoint.

        • Status — (String)

          The status of the source region.

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.

Service Reference:

Examples:

Calling the downloadDBLogFilePortion operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  LogFileName: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  NumberOfLines: 0
};
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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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 will be 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 is not 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 subsequent 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the failoverDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  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 is not case-sensitive.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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 result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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.

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 RDS Amazon Resource Name (ARN).

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Namerequired — (String)

        This parameter is not currently supported.

      • Valuesrequired — (Array<String>)

        This parameter is not currently supported.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the modifyDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  BackupRetentionPeriod: 0,
  DBClusterParameterGroupName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  MasterUserPassword: 'STRING_VALUE',
  NewDBClusterIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: '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 is not case-sensitive.

      Constraints:

      • Must be the identifier for an existing DB cluster.

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

      • First character must be a letter.

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

    • 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 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • ApplyImmediately — (Boolean)

      A value that specifies whether the 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 set to false, changes to the DB cluster are applied during the next maintenance window.

      The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

      Default: false

    • BackupRetentionPeriod — (Integer)

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

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • DBClusterParameterGroupName — (String)

      The name of the 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 does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true 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 cannot be removed from an option group. The option group cannot 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.

      Default: A 30-minute window selected at random from an 8-hour block of time per 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.

      • Times should 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

      Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

      Constraints: Minimum 30-minute window.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

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

      • DBCluster — (map)

        Contains the result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can 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 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 command to verify that your DB cluster parameter group has been created or modified.

Service Reference:

Examples:

Calling the modifyDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [ /* required */
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

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

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        Constraints:

        • Must be 1 to 255 alphanumeric characters

        • First character must be a letter

        • Cannot end with a hyphen or contain two consecutive hyphens

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request)

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

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

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

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 AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

    • ValuesToAdd — (Array<String>)

      A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS 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 AWS accounts.

    • ValuesToRemove — (Array<String>)

      A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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.

Service Reference:

Examples:

Calling the modifyDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  AllocatedStorage: 0,
  AllowMajorVersionUpgrade: true || false,
  ApplyImmediately: true || false,
  AutoMinorVersionUpgrade: true || false,
  BackupRetentionPeriod: 0,
  CACertificateIdentifier: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBInstanceClass: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBPortNumber: 0,
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 0,
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MonitoringInterval: 0,
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  NewDBInstanceIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 0,
  PubliclyAccessible: true || false,
  StorageType: 'STRING_VALUE',
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  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 be the identifier for an existing DB instance

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • AllocatedStorage — (Integer)

      The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

      MySQL

      Default: Uses existing setting

      Valid Values: 5-6144

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

      Type: Integer

      MariaDB

      Default: Uses existing setting

      Valid Values: 5-6144

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

      Type: Integer

      PostgreSQL

      Default: Uses existing setting

      Valid Values: 5-6144

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

      Type: Integer

      Oracle

      Default: Uses existing setting

      Valid Values: 10-6144

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

      SQL Server

      Cannot be modified.

      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 will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • DBInstanceClass — (String)

      The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action. Note that not all instance classes are available in all regions for all DB engines.

      Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

    • 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 is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance.

      Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

      Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.

      Example: mySubnetGroup

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • ApplyImmediately — (Boolean)

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

      Default: false

    • MasterUserPassword — (String)

      The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

      Changing this parameter does not 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.

      Default: Uses existing setting

      Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

      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 does not 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. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this 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.

      Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true 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.

      Default: Uses existing setting

      Constraints:

      • Must be a value from 0 to 35

      • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6

      • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

      • Cannot 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, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

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

      • Times should 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 does not 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.

      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)

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Constraints: Cannot be specified if the DB instance is a Read Replica.

    • 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 set to true for this request.

      For major version upgrades, if a non-default 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.

      For a list of valid engine versions, see CreateDBInstance.

    • AllowMajorVersionUpgrade — (Boolean)

      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that 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 new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

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

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not supported.

      Type: Integer

      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 will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be 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.

    • OptionGroupName — (String)

      Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true 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, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    • 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 will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

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

    • TdeCredentialArn — (String)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the Key Store in order to access the device.

    • CACertificateIdentifier — (String)

      Indicates the certificate that needs to be associated with the instance.

    • Domain — (String)

      The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

    • 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. The default is 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

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

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      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 for 1434, 3389, 47001, 49152, and 49152 through 49156.

      Amazon Aurora

      Default: 3306

      Valid Values: 1150-65535

    • PubliclyAccessible — (Boolean)

      Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal 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 true in order for it to be publicly accessible.

      Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

      Default: false

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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.

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

    • DomainIAMRoleName — (String)

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

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

      Default: 1

      Valid Values: 0 - 15

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

      You can enable IAM database authentication 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

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

      • DBInstance — (map)

        Contains the result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

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.

Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

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'
    },
    /* 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:

      • Must be the name of an existing DB parameter group

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • Parameters — (Array<map>)

      An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent 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, and changes are applied when you reboot the DB instance without failover.
      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

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

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBParameterGroupName — (String)

        Provides the name of the DB parameter group.

Returns:

  • (AWS.Request)

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

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

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. You can update the engine version to either a new major or minor engine version.

Amazon RDS supports upgrading a MySQL DB snapshot from MySQL 5.1 to MySQL 5.5.

Service Reference:

Examples:

Calling the modifyDBSnapshot operation

var params = {
  DBSnapshotIdentifier: 'STRING_VALUE', /* required */
  EngineVersion: '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 update the DB snapshot 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:

      • DBSnapshot — (map)

        Contains the result of a successful invocation of the following actions:

        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)

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

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gigabytes (GB).

        • 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 when the snapshot was taken, in Universal Coordinated Time (UTC).

        • 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 region that the DB snapshot was created in or copied from.

        • SourceDBSnapshotIdentifier — (String)

          The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer 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 KMS key identifier for the encrypted DB snapshot.

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

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 AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS 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.

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 AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

    • ValuesToAdd — (Array<String>)

      A list of DB snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.

    • ValuesToRemove — (Array<String>)

      A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 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.

      Constraints: Must contain no more than 255 alphanumeric characters, 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.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 result of a successful invocation of the following actions:

        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)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Contains Availability Zone information.

            This data type is used as an element in the following data type:

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

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

Returns:

  • (AWS.Request)

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

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

Modifies an existing RDS event notification subscription. Note that you cannot 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 SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

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 will be 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 is not specified, all events are returned.

      Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    • EventCategories — (Array<String>)

      A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    • Enabled — (Boolean)

      A Boolean value; set to true to activate the subscription.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • EventSubscription — (map)

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

        • CustomerAwsId — (String)

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

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: 0,
      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, cannot be removed from an option group, and that option group cannot 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.

      • OptionNamerequired — (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 DBSecurityGroupMemebrship name strings used for this option.

      • VpcSecurityGroupMemberships — (Array<String>)

        A list of VpcSecurityGroupMemebrship 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)

      Indicates whether the changes should be applied 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: We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

Service Reference:

Examples:

Calling the promoteReadReplica operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  BackupRetentionPeriod: 0,
  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 be the identifier for an existing Read Replica DB instance

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: mydbinstance

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

      Default: 1

      Constraints:

      • Must be a value from 0 to 8

    • PreferredBackupWindow — (String)

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

      Default: A 30-minute window selected at random from an 8-hour block of time per 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.

      • Times should 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 result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

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.

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 is not case-sensitive.

      Constraints:

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

      • First character must be a letter.

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

      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 result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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.

Examples:

Calling the purchaseReservedDBInstancesOffering operation

var params = {
  ReservedDBInstancesOfferingId: 'STRING_VALUE', /* required */
  DBInstanceCount: 0,
  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.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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.

Returns:

  • (AWS.Request)

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

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

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

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 contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • ForceFailover — (Boolean)

      When true, the reboot will be conducted through a MultiAZ failover.

      Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

Returns:

  • (AWS.Request)

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

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

Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

Service Reference:

Examples:

Calling the removeRoleFromDBCluster operation

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

      the error object returned from the request. Set to 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.

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

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 the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    • TagKeys — (Array<String>)

      The tag key (name) of the tag to be removed.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Modifies the parameters of a 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the resetDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [
    {
      AllowedValues: 'STRING_VALUE',
      ApplyMethod: immediate | pending-reboot,
      ApplyType: 'STRING_VALUE',
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
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 is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot 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 cannot use this parameter if the ResetAllParameters parameter is set to true.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

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

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        Constraints:

        • Must be 1 to 255 alphanumeric characters

        • First character must be a letter

        • Cannot end with a hyphen or contain two consecutive hyphens

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request)

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

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'
    },
    /* 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 be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • ResetAllParameters — (Boolean)

      Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

      Default: true

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

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

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

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 */
  ],
  BackupRetentionPeriod: 0,
  CharacterSetName: 'STRING_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

    • 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 S3 bucket. This parameter is isn't case-sensitive.

      Constraints:

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

      • First character must be a letter.

      • Cannot 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 will be used.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

      Example: mySubnetgroup

    • Engine — (String)

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

      Valid Values: aurora

    • EngineVersion — (String)

      The version number of the database engine to use.

      Aurora

      Example: 5.6.10a

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

      • First character must be a letter.

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

    • MasterUserPassword — (String)

      The password for the master database user. This password can contain any printable ASCII character except "/", """, 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 cannot be removed from an option group. An option group cannot 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.

      Default: A 30-minute window selected at random from an 8-hour block of time per 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.

      • Times should 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

      Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

      Constraints: Minimum 30-minute window.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • StorageEncrypted — (Boolean)

      Specifies whether the restored DB cluster is encrypted.

    • KmsKeyId — (String)

      The KMS key identifier for an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

      If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • 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 version 5.5 and 5.6 are supported.

      Example: 5.6.22

    • 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 AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (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 result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the restoreDBClusterFromSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

    • DBClusterIdentifier — (String)

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

      Constraints:

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

    • SnapshotIdentifier — (String)

      The identifier for the DB cluster snapshot to restore from.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

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

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: 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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

      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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If you do not specify a value for the KmsKeyId parameter, then the following will occur:

      • If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.

      • If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

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

      • DBCluster — (map)

        Contains the result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Service Reference:

Examples:

Calling the restoreDBClusterToPointInTime operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  SourceDBClusterIdentifier: 'STRING_VALUE', /* required */
  DBSubnetGroupName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  RestoreToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseLatestRestorableTime: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
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 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • SourceDBClusterIdentifier — (String)

      The identifier of the source DB cluster from which to restore.

      Constraints:

      • Must be the identifier of an existing database instance

      • Must contain from 1 to 63 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • 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

      • Cannot be specified if UseLatestRestorableTime parameter is true

      Example: 2015-03-07T23:45:00Z

    • UseLatestRestorableTime — (Boolean)

      A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

      Default: false

      Constraints: Cannot be specified if RestoreToTime parameter is provided.

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB cluster.

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new DB cluster.

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

      Example: mySubnetgroup

    • OptionGroupName — (String)

      The name of the option group for the new DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A lst of VPC security groups that the new DB cluster belongs to.

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

      If you do not specify a value for the KmsKeyId parameter, then the following will occur:

      • 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 is not encrypted, then the restored DB cluster is not encrypted.

      If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

    • EnableIAMDatabaseAuthentication — (Boolean)

      A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

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

      • DBCluster — (map)

        Contains the result of a successful invocation of the following actions:

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

        • AllocatedStorage — (Integer)

          For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

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

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

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

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

        • Engine — (String)

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

        • 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 true, the KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS 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 AWS 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 AWS 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 AWS 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 AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

        • ClusterCreateTime — (Date)

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

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 the most of original configuration with the default security 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 AZ deployment and not a single-AZ deployment.

If your intent is 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 does not allow two DB instances with the same name. Once 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 will 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.

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,
  DBInstanceClass: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  Engine: 'STRING_VALUE',
  Iops: 0,
  LicenseModel: 'STRING_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PubliclyAccessible: true || false,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE'
};
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 alphanumeric characters or hyphens (1 to 15 for SQL Server)

      • First character must be a letter

      • Cannot 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 contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      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.

      Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

    • 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 EC2 Availability Zone that the database instance will be created in.

      Default: A random, system-chosen Availability Zone.

      Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

      Example: us-east-1a

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new instance.

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

      Example: mySubnetgroup

    • MultiAZ — (Boolean)

      Specifies if the DB instance is a Multi-AZ deployment.

      Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    • PubliclyAccessible — (Boolean)

      Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

      • Default VPC: true

      • VPC: false

      If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

    • LicenseModel — (String)

      License model information for the restored DB instance.

      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 doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
    • Engine — (String)

      The database engine to use for the new instance.

      Default: The same as source

      Constraint: Must be compatible with the engine of the source. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

      Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

    • Iops — (Integer)

      Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

      Constraints: Must be an integer greater than 1000.

      SQL Server

      Setting the IOPS value for the SQL Server database engine is not 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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    • Tags — (Array<map>)

      A list of tags.

      • 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 cannot be prefixed with "aws:" 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 cannot be prefixed with "aws:" 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 standard

    • TdeCredentialArn — (String)

      The ARN from the Key Store with which to associate the instance for TDE encryption.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the Key Store in order to access the device.

    • Domain — (String)

      Specify the Active Directory Domain to restore the instance in.

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

    • DomainIAMRoleName — (String)

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

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

      You can enable IAM database authentication 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.

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

      • DBInstance — (map)

        Contains the result of a successful invocation of the following actions:

        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)

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

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

          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.

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

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

          Provides List of DB security group elements containing only 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 DP 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)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Contains Availability Zone information.

              This data type is used as an element in the following data type:

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

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

        • PreferredMaintenanceWindow — (String)

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

        • PendingModifiedValues — (map)

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

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

          • MasterUserPassword — (String)

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

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

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

          • MultiAZ — (Boolean)

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

          • EngineVersion — (String)

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

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

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

          • StorageType — (String)

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

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

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

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          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 that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

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

        • 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

          Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

          • Default VPC:true

          • VPC:false

          If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.

          • Message — (String)

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

        • 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 KMS key identifier for the encrypted DB instance.

        • DbiResourceId — (String)

          The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the 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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

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

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

        • 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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.

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.

Service Reference:

Examples:

Calling the restoreDBInstanceToPointInTime operation

var params = {
  SourceDBInstanceIdentifier: 'STRING_VALUE', /* required */
  TargetDBInstanceIdentifier: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBInstanceClass: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  Engine: 'STRING_VALUE',
  Iops: 0,
  LicenseModel: 'STRING_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  Port: 0,
  PubliclyAccessible: true || false,
  RestoreTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: