Class: AWS.RDS

Overview

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

Service Description

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

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

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

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.

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.

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

ResourcePendingMaintenanceActions — (map)

Describes the pending maintenance actions for a resource.

ResourceIdentifier — (String)

The ARN of the resource that has pending maintenance actions.

PendingMaintenanceActionDetails — (Array<map>)

A list that provides details about the pending maintenance actions for the resource.

Action — (String)

The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, and hardware-maintenance.

AutoAppliedAfterDate — (Date)

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

ForcedApplyDate — (Date)

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

OptInStatus — (String)

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

CurrentApplyDate — (Date)

The effective date when the pending maintenance action is applied to the resource. 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.

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

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

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.

The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.

First character must be a letter.

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

Example: my-cluster1

BacktrackTo — (Date)

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

Note: If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

Must contain a valid ISO 8601 timestamp.

Can't contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

Force — (Boolean)

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

UseEarliestTimeOnPointInTimeUnavailable — (Boolean)

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

Callback (callback):

function(err, data) { ... }

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

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

Constraints:

Must specify a valid DB cluster parameter group.

If the source DB cluster parameter group is in the same AWS 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 AWS 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.

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

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

PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS 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 AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

DestinationRegion - The name of the AWS 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS 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 AWS 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 AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

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

You can't copy an encrypted, shared DB cluster 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 AWS Region as the copy, specify a valid DB snapshot identifier.

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

Example: my-cluster-snapshot1

TargetDBClusterSnapshotIdentifier — (String)

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

Constraints:

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

First character must be a letter.

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

Example: my-cluster-snapshot2

KmsKeyId — (String)

The AWS 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 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 AWS 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 AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

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

PreSignedUrl — (String)

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the 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 AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

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

DestinationRegion - The name of the AWS 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

SourceRegion — (String)

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

Callback (callback):

function(err, data) { ... }

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

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

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

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

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

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 encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

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

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

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

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

CopyTags — (Boolean)

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

PreSignedUrl — (String)

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

You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS 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 is copied to. This AWS 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 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS 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 AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

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

OptionGroupName — (String)

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

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

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.

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBSnapshot — (map)

Contains the details of an Amazon RDS DB snapshot.

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

DBSnapshotIdentifier — (String)

Specifies the identifier for the DB snapshot.

DBInstanceIdentifier — (String)

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

SnapshotCreateTime — (Date)

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 gibibytes (GiB).

Status — (String)

Specifies the status of this DB snapshot.

Port — (Integer)

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

AvailabilityZone — (String)

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

VpcId — (String)

Provides the VPC ID associated with the DB snapshot.

InstanceCreateTime — (Date)

Specifies the time 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 AWS Region that the DB snapshot was created in or copied from.

SourceDBSnapshotIdentifier — (String)

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has 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 AWS 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, and otherwise false.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DbiResourceId — (String)

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

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

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

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.

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

BackupRetentionPeriod — (Integer)

The number of days for which automated backups are retained.

Default: 1

Constraints:

Must be a value from 1 to 35

CharacterSetName — (String)

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

DatabaseName — (String)

The name for your database of up to 64 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 letters, numbers, or hyphens.

First character must be a letter.

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

Example: my-cluster1

DBClusterParameterGroupName — (String)

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

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

VpcSecurityGroupIds — (Array<String>)

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

DBSubnetGroupName — (String)

A DB subnet group to associate with this DB cluster.

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

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

Tags — (Array<map>)

Tags to assign to the DB cluster.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

StorageEncrypted — (Boolean)

A value that indicates whether the DB cluster is encrypted.

KmsKeyId — (String)

The AWS 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 an encryption key is not specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

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

PreSignedUrl — (String)

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

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

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

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

DestinationRegion - The name of the AWS 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 AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

CharacterSetName — (String)

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

DatabaseName — (String)

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

DBClusterIdentifier — (String)

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

DBClusterParameterGroup — (String)

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

DBSubnetGroup — (String)

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

Status — (String)

Specifies the current state of this DB cluster.

PercentProgress — (String)

Specifies the progress of the operation as a percentage.

EarliestRestorableTime — (Date)

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

Endpoint — (String)

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

ReaderEndpoint — (String)

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

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

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)

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

DBClusterParameterGroupStatus — (String)

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

PromotionTier — (Integer)

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

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

HostedZoneId — (String)

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

StorageEncrypted — (Boolean)

Specifies whether the DB cluster is encrypted.

KmsKeyId — (String)

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

DbClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.

FeatureName — (String)

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled — (Boolean)

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

CloneGroupId — (String)

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

ClusterCreateTime — (Date)

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

EarliestBacktrackTime — (Date)

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

BacktrackWindow — (Integer)

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

BacktrackConsumedChangeRecords — (Integer)

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports — (Array<String>)

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

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

Capacity — (Integer)

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

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

MaxCapacity — (Integer)

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

AutoPause — (Boolean)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

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

SecondsUntilAutoPause — (Integer)

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

TimeoutAction — (String)

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

DeletionProtection — (Boolean)

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

HttpEndpointEnabled — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

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

DBClusterEndpointIdentifier — (String)

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

EndpointType — (String)

The type of the endpoint. One of: READER, ANY.

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBClusterEndpointIdentifier — (String)

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

DBClusterIdentifier — (String)

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

DBClusterEndpointResourceIdentifier — (String)

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

Endpoint — (String)

The DNS address of the endpoint.

Status — (String)

The current status of the endpoint. One of: creating, available, deleting, modifying.

EndpointType — (String)

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

CustomEndpointType — (String)

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

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

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

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

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

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

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7

Aurora PostgreSQL

Example: aurora-postgresql9.6

Description — (String)

The description for the DB cluster parameter group.

Tags — (Array<map>)

Tags to assign to the DB cluster parameter group.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

Constraints:

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

First character must be a letter.

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

Example: my-cluster1-snapshot1

DBClusterIdentifier — (String)

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

Constraints:

Must match the identifier of an existing DBCluster.

Example: my-cluster1

Tags — (Array<map>)

The tags to be assigned to the DB cluster snapshot.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

MySQL

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

Constraints:

Must contain 1 to 64 letters or numbers.

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

MariaDB

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

Constraints:

Must contain 1 to 64 letters or numbers.

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

PostgreSQL

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

Constraints:

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

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

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

Oracle

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

Default: ORCL

Constraints:

Can't be longer than 8 characters

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 letters or numbers.

Can't 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 letters, numbers, or hyphens.

First character must be a letter.

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

Example: mydbinstance

AllocatedStorage — (Integer)

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

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

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

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

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

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

MariaDB

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

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

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

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

PostgreSQL

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

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

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

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

Oracle

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

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

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

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

SQL Server

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

General Purpose (SSD) storage (gp2):

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

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

Provisioned IOPS storage (io1):

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

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

Magnetic storage (standard):

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

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

DBInstanceClass — (String)

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Engine — (String)

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

Not every database engine is available for every AWS Region.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)

aurora-mysql (for MySQL 5.7-compatible Aurora)

aurora-postgresql

mariadb

mysql

oracle-ee

oracle-se2

oracle-se1

oracle-se

postgres

sqlserver-ee

sqlserver-se

sqlserver-ex

sqlserver-web

MasterUsername — (String)

The name for the master user.

Amazon Aurora

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

MariaDB

Constraints:

Required for MariaDB.

Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

Required for SQL Server.

Must be 1 to 128 letters or numbers.

The first character must be a letter.

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

MySQL

Constraints:

Required for MySQL.

Must be 1 to 16 letters or numbers.

First character must be a letter.

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

Oracle

Constraints:

Required for Oracle.

Must be 1 to 30 letters or numbers.

First character must be a letter.

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

PostgreSQL

Constraints:

Required for PostgreSQL.

Must be 1 to 63 letters or numbers.

First character must be a letter.

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

MasterUserPassword — (String)

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

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

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

DBSecurityGroups — (Array<String>)

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

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

VpcSecurityGroupIds — (Array<String>)

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

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

AvailabilityZone — (String)

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

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS 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 time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

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

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

Constraints: Minimum 30-minute window.

DBParameterGroupName — (String)

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

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

First character must be a letter

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

BackupRetentionPeriod — (Integer)

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

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

Must be a value from 0 to 35

Can't be set to 0 if the DB instance is a source to Read Replicas

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 The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

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

CharacterSetName — (String)

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

Amazon Aurora

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

PubliclyAccessible — (Boolean)

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

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

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

Tags — (Array<map>)

Tags to assign to the DB instance.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

DBClusterIdentifier — (String)

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

StorageType — (String)

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

Valid values: standard | gp2 | io1

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

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

TdeCredentialArn — (String)

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

TdeCredentialPassword — (String)

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

StorageEncrypted — (Boolean)

A value that indicates whether the DB instance is encrypted. By default, it is not encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

KmsKeyId — (String)

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

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

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

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

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

MonitoringInterval — (Integer)

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable 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 Amazon 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 in the Amazon RDS User Guide.

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

Default: 1

Valid Values: 0 - 15

Timezone — (String)

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

EnableIAMDatabaseAuthentication — (Boolean)

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

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

For MySQL 5.6, minor version 5.6.34 or higher

For MySQL 5.7, minor version 5.7.16 or higher

EnablePerformanceInsights — (Boolean)

A value that indicates whether to enable Performance Insights for the DB instance.

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

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.

PerformanceInsightsRetentionPeriod — (Integer)

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

EnableCloudwatchLogsExports — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DeletionProtection — (Boolean)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBInstance — (map)

Contains the details of an Amazon RDS DB instance.

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

DBInstanceIdentifier — (String)

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

DBInstanceClass — (String)

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

Engine — (String)

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.

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

InstanceCreateTime — (Date)

Provides the date and time the DB instance was created.

PreferredBackupWindow — (String)

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

DBSecurityGroups — (Array<map>)

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

DBSecurityGroupName — (String)

The name of the DB security group.

Status — (String)

The status of the DB security group.

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

DBParameterGroups — (Array<map>)

Provides the list of DB parameter groups applied to this DB instance.

DBParameterGroupName — (String)

The name of the 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 OrderableDBInstanceOption 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 currently being applied.

AllocatedStorage — (Integer)

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

MasterUserPassword — (String)

Contains the pending or currently-in-progress change of the master credentials for the 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.

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

DBInstanceIdentifier — (String)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

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.

PendingCloudwatchLogsExports — (map)

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

LogTypesToEnable — (Array<String>)

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

LogTypesToDisable — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

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 to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Note: Currently, each RDS DB instance can have only one Aurora Read Replica.

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.

StatusInfos — (Array<map>)

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

StatusType — (String)

This value is currently "read replication."

Normal — (Boolean)

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

Status — (String)

Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message — (String)

Details of the error if there is an error for the instance. If the instance 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 AWS KMS key identifier for the encrypted DB instance.

DbiResourceId — (String)

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

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.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

MonitoringInterval — (Integer)

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

EnhancedMonitoringResourceArn — (String)

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

MonitoringRoleArn — (String)

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

PromotionTier — (Integer)

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

DBInstanceArn — (String)

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

Timezone — (String)

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

IAMDatabaseAuthenticationEnabled — (Boolean)

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

IAM database authentication can be enabled for the following database engines

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide.

Amazon Aurora doesn't 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 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 following.

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

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

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

If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

DBInstanceClass — (String)

The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

A value that indicates whether the Read Replica is in a Multi-AZ deployment.

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

AutoMinorVersionUpgrade — (Boolean)

A value that indicates whether minor engine upgrades are 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 is associated with. If omitted, the option group associated with the source instance is used.

PubliclyAccessible — (Boolean)

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

DBSubnetGroupName — (String)

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

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

The specified DB subnet group must be in the same AWS Region in which the operation is running.

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

Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

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

Example: mySubnetgroup

VpcSecurityGroupIds — (Array<String>)

A list of EC2 VPC security groups to associate with the Read Replica.

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

StorageType — (String)

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

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

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

CopyTagsToSnapshot — (Boolean)

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

MonitoringInterval — (Integer)

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

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

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

MonitoringRoleArn — (String)

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

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

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 encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. 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 AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

You can't create an encrypted Read Replica from an unencrypted DB instance.

PreSignedUrl — (String)

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

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

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

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

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

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

SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

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

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.

PerformanceInsightsRetentionPeriod — (Integer)

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

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

UseDefaultProcessorFeatures — (Boolean)

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

DeletionProtection — (Boolean)

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

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.

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBInstance — (map)

Contains the details of an Amazon RDS DB instance.

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

DBInstanceIdentifier — (String)

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

DBInstanceClass — (String)

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

Engine — (String)

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.

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

InstanceCreateTime — (Date)

Provides the date and time the DB instance was created.

PreferredBackupWindow — (String)

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

DBSecurityGroups — (Array<map>)

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

DBSecurityGroupName — (String)

The name of the DB security group.

Status — (String)

The status of the DB security group.

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

DBParameterGroups — (Array<map>)

Provides the list of DB parameter groups applied to this DB instance.

DBParameterGroupName — (String)

The name of the 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 OrderableDBInstanceOption 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 currently being applied.

AllocatedStorage — (Integer)

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

MasterUserPassword — (String)

Contains the pending or currently-in-progress change of the master credentials for the 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.

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

DBInstanceIdentifier — (String)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

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.

PendingCloudwatchLogsExports — (map)

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

LogTypesToEnable — (Array<String>)

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

LogTypesToDisable — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

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 to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Note: Currently, each RDS DB instance can have only one Aurora Read Replica.

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.

StatusInfos — (Array<map>)

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

StatusType — (String)

This value is currently "read replication."

Normal — (Boolean)

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

Status — (String)

Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message — (String)

Details of the error if there is an error for the instance. If the instance 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 AWS KMS key identifier for the encrypted DB instance.

DbiResourceId — (String)

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

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.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

MonitoringInterval — (Integer)

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

EnhancedMonitoringResourceArn — (String)

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

MonitoringRoleArn — (String)

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

PromotionTier — (Integer)

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

DBInstanceArn — (String)

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

Timezone — (String)

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

IAMDatabaseAuthenticationEnabled — (Boolean)

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

IAM database authentication can be enabled for the following database engines

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.

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

To list all of the available parameter group families, use the following command:

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

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

First character must be a letter

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

Must not be "Default"

Example: mysecuritygroup

DBSecurityGroupDescription — (String)

The description for the DB security group.

Tags — (Array<map>)

Tags to assign to the DB security group.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBSnapshot — (map)

Contains the details of an Amazon RDS DB snapshot.

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

DBSnapshotIdentifier — (String)

Specifies the identifier for the DB snapshot.

DBInstanceIdentifier — (String)

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

SnapshotCreateTime — (Date)

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 gibibytes (GiB).

Status — (String)

Specifies the status of this DB snapshot.

Port — (Integer)

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

AvailabilityZone — (String)

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

VpcId — (String)

Provides the VPC ID associated with the DB snapshot.

InstanceCreateTime — (Date)

Specifies the time 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 AWS Region that the DB snapshot was created in or copied from.

SourceDBSnapshotIdentifier — (String)

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has 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 AWS 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, and otherwise false.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DbiResourceId — (String)

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

The name for the DB subnet group. This value is stored as a lowercase string.

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

Example: mySubnetgroup

DBSubnetGroupDescription — (String)

The description for the DB subnet group.

SubnetIds — (Array<String>)

The EC2 Subnet IDs for the DB subnet group.

Tags — (Array<map>)

Tags to assign to the DB subnet group.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

SourceType — (String)

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

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 are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

If SourceIds are supplied, SourceType must also be provided.

If the source type is a DB instance, 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 value that indicates whether to activate the subscription. If the event notification subscription is not activated, the subscription is created but not active.

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

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

Tags to assign to the option group.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

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

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match an existing DBClusterIdentifier.

SkipFinalSnapshot — (Boolean)

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip is not specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip is not specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

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

FinalDBSnapshotIdentifier — (String)

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Note: Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

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

First character must be a letter

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

Callback (callback):

function(err, data) { ... }

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

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

CharacterSetName — (String)

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

DatabaseName — (String)

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

DBClusterIdentifier — (String)

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

DBClusterParameterGroup — (String)

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

DBSubnetGroup — (String)

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

Status — (String)

Specifies the current state of this DB cluster.

PercentProgress — (String)

Specifies the progress of the operation as a percentage.

EarliestRestorableTime — (Date)

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

Endpoint — (String)

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

ReaderEndpoint — (String)

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

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

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)

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

DBClusterParameterGroupStatus — (String)

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

PromotionTier — (Integer)

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

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

HostedZoneId — (String)

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

StorageEncrypted — (Boolean)

Specifies whether the DB cluster is encrypted.

KmsKeyId — (String)

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

DbClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.

FeatureName — (String)

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled — (Boolean)

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

CloneGroupId — (String)

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

ClusterCreateTime — (Date)

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

EarliestBacktrackTime — (Date)

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

BacktrackWindow — (Integer)

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

BacktrackConsumedChangeRecords — (Integer)

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports — (Array<String>)

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

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

Capacity — (Integer)

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

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

MaxCapacity — (Integer)

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

AutoPause — (Boolean)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

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

SecondsUntilAutoPause — (Integer)

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

TimeoutAction — (String)

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

DeletionProtection — (Boolean)

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

HttpEndpointEnabled — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBClusterEndpointIdentifier — (String)

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

DBClusterIdentifier — (String)

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

DBClusterEndpointResourceIdentifier — (String)

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

Endpoint — (String)

The DNS address of the endpoint.

Status — (String)

The current status of the endpoint. One of: creating, available, deleting, modifying.

EndpointType — (String)

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

CustomEndpointType — (String)

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

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

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

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 you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match the name of an existing DB instance.

SkipFinalSnapshot — (Boolean)

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip is not specified, a DB snapshot is created before the DB instance is deleted. By default, skip is not specified, and the DB snapshot is created.

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 skip is specified.

Specify skip when deleting a Read Replica.

Note: The FinalDBSnapshotIdentifier parameter must be specified if skip is not specified.

FinalDBSnapshotIdentifier — (String)

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Note: Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

Must be 1 to 255 letters or numbers.

First character must be a letter.

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

Can't be specified when deleting a Read Replica.

DeleteAutomatedBackups — (Boolean)

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBInstance — (map)

Contains the details of an Amazon RDS DB instance.

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

DBInstanceIdentifier — (String)

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

DBInstanceClass — (String)

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

Engine — (String)

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.

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

InstanceCreateTime — (Date)

Provides the date and time the DB instance was created.

PreferredBackupWindow — (String)

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

DBSecurityGroups — (Array<map>)

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

DBSecurityGroupName — (String)

The name of the DB security group.

Status — (String)

The status of the DB security group.

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

DBParameterGroups — (Array<map>)

Provides the list of DB parameter groups applied to this DB instance.

DBParameterGroupName — (String)

The name of the 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 OrderableDBInstanceOption 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 currently being applied.

AllocatedStorage — (Integer)

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

MasterUserPassword — (String)

Contains the pending or currently-in-progress change of the master credentials for the 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.

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

DBInstanceIdentifier — (String)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

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.

PendingCloudwatchLogsExports — (map)

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

LogTypesToEnable — (Array<String>)

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

LogTypesToDisable — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

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 to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Note: Currently, each RDS DB instance can have only one Aurora Read Replica.

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.

StatusInfos — (Array<map>)

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

StatusType — (String)

This value is currently "read replication."

Normal — (Boolean)

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

Status — (String)

Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message — (String)

Details of the error if there is an error for the instance. If the instance 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 AWS KMS key identifier for the encrypted DB instance.

DbiResourceId — (String)

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

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.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

MonitoringInterval — (Integer)

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

EnhancedMonitoringResourceArn — (String)

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

MonitoringRoleArn — (String)

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

PromotionTier — (Integer)

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

DBInstanceArn — (String)

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

Timezone — (String)

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

IAMDatabaseAuthenticationEnabled — (Boolean)

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

IAM database authentication can be enabled for the following database engines

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBSnapshot — (map)

Contains the details of an Amazon RDS DB snapshot.

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

DBSnapshotIdentifier — (String)

Specifies the identifier for the DB snapshot.

DBInstanceIdentifier — (String)

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

SnapshotCreateTime — (Date)

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 gibibytes (GiB).

Status — (String)

Specifies the status of this DB snapshot.

Port — (Integer)

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

AvailabilityZone — (String)

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

VpcId — (String)

Provides the VPC ID associated with the DB snapshot.

InstanceCreateTime — (Date)

Specifies the time 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 AWS Region that the DB snapshot was created in or copied from.

SourceDBSnapshotIdentifier — (String)

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has 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 AWS 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, and otherwise false.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DbiResourceId — (String)

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

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.

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

Constraints:

Must match an existing CertificateIdentifier.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

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

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

db-cluster-backtrack-status - Accepts any of the following backtrack status values:

applying

completed

failed

pending

The results list includes information about only the backtracks identified by these values.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

Callback (callback):

function(err, data) { ... }

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

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

DBClusterEndpointIdentifier — (String)

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Filters — (Array<map>)

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

Marker — (String)

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

DBClusterEndpoints — (Array<map>)

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

DBClusterEndpointIdentifier — (String)

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

DBClusterIdentifier — (String)

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

DBClusterEndpointResourceIdentifier — (String)

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

Endpoint — (String)

The DNS address of the endpoint.

Status — (String)

The current status of the endpoint. One of: creating, available, deleting, modifying.

EndpointType — (String)

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

CustomEndpointType — (String)

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

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

The name of a specific DB cluster parameter group to return details for.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

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

Parameters:

err(Error)
—

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

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

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

Source — (String)

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

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

Parameters — (Array<map>)

Provides a list of parameters for the DB cluster parameter group.

ParameterName — (String)

Specifies the name of the parameter.

ParameterValue — (String)

Specifies the value of the parameter.

Description — (String)

Provides a description of the parameter.

Source — (String)

Indicates the source of the parameter value.

ApplyType — (String)

Specifies the engine specific parameters type.

DataType — (String)

Specifies the valid data type for the parameter.

AllowedValues — (String)

Specifies the valid range of values for the parameter.

IsModifiable — (Boolean)

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

MinimumEngineVersion — (String)

The earliest engine version to which the parameter can apply.

ApplyMethod — (String)

Indicates when to apply parameter updates.

Possible values include:

"immediate"

"pending-reboot"

SupportedEngineModes — (Array<String>)

The valid DB engine modes.

Marker — (String)

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

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

Filters — (Array<map>)

A filter that specifies one or more DB clusters to describe.

Supported filters:

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.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

CharacterSetName — (String)

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

DatabaseName — (String)

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

DBClusterIdentifier — (String)

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

DBClusterParameterGroup — (String)

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

DBSubnetGroup — (String)

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

Status — (String)

Specifies the current state of this DB cluster.

PercentProgress — (String)

Specifies the progress of the operation as a percentage.

EarliestRestorableTime — (Date)

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

Endpoint — (String)

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

ReaderEndpoint — (String)

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

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

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)

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

DBClusterParameterGroupStatus — (String)

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

PromotionTier — (Integer)

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

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

HostedZoneId — (String)

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

StorageEncrypted — (Boolean)

Specifies whether the DB cluster is encrypted.

KmsKeyId — (String)

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

DbClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.

FeatureName — (String)

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled — (Boolean)

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

CloneGroupId — (String)

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

ClusterCreateTime — (Date)

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

EarliestBacktrackTime — (Date)

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

BacktrackWindow — (Integer)

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

BacktrackConsumedChangeRecords — (Integer)

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports — (Array<String>)

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

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

Capacity — (Integer)

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

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

MaxCapacity — (Integer)

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

AutoPause — (Boolean)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

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

SecondsUntilAutoPause — (Integer)

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

TimeoutAction — (String)

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

DeletionProtection — (Boolean)

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

HttpEndpointEnabled — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

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.

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

Parameters:

err(Error)
—

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

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

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBCluster.

DBClusterSnapshotIdentifier — (String)

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

Constraints:

If supplied, must match the identifier of an existing DBClusterSnapshot.

If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

SnapshotType — (String)

The type of DB cluster snapshots to be returned. You can specify one of the following values:

automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my 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 enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

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

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

IncludeShared — (Boolean)

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

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)

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

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

Parameters:

err(Error)
—

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

data(Object)
—

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

Marker — (String)

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

DBClusterSnapshots — (Array<map>)

Provides a list of DB cluster snapshots for the user.

AvailabilityZones — (Array<String>)

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

DBClusterSnapshotIdentifier — (String)

Specifies the identifier for the DB cluster snapshot.

DBClusterIdentifier — (String)

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

SnapshotCreateTime — (Date)

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

Engine — (String)

Specifies the name of the database engine.

AllocatedStorage — (Integer)

Specifies the allocated storage size in gibibytes (GiB).

Status — (String)

Specifies the status of this DB cluster snapshot.

Port — (Integer)

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

VpcId — (String)

Provides the VPC ID associated with the DB cluster snapshot.

ClusterCreateTime — (Date)

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

MasterUsername — (String)

Provides the master username for 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 AWS 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, and otherwise false.

The name of a specific DB parameter group family to return details for.

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

The maximum number of records to include in the response. If more 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)

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

ListSupportedCharacterSets — (Boolean)

A value that indicates whether to list the supported character sets for each engine version.

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

ListSupportedTimezones — (Boolean)

A value that indicates whether to list the supported time zones for each engine version.

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

Callback (callback):

function(err, data) { ... }

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

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

DBInstanceIdentifier — (String)

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

Filters — (Array<map>)

A filter that specifies which resources to return based on status.

Supported filters are the following:

status

active - automated backups for current instances

retained - automated backups for deleted instances

creating - automated backups that are waiting for the first automated snapshot to be available

db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBInstance.

Filters — (Array<map>)

A filter that specifies one or more DB instances to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

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

Parameters:

err(Error)
—

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

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

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

InstanceCreateTime — (Date)

Provides the date and time the DB instance was created.

PreferredBackupWindow — (String)

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

DBSecurityGroups — (Array<map>)

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

DBSecurityGroupName — (String)

The name of the DB security group.

Status — (String)

The status of the DB security group.

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

DBParameterGroups — (Array<map>)

Provides the list of DB parameter groups applied to this DB instance.

DBParameterGroupName — (String)

The name of the 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 OrderableDBInstanceOption 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 currently being applied.

AllocatedStorage — (Integer)

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

MasterUserPassword — (String)

Contains the pending or currently-in-progress change of the master credentials for the 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.

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

DBInstanceIdentifier — (String)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

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.

PendingCloudwatchLogsExports — (map)

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

LogTypesToEnable — (Array<String>)

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

LogTypesToDisable — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

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 to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Note: Currently, each RDS DB instance can have only one Aurora Read Replica.

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.

StatusInfos — (Array<map>)

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

StatusType — (String)

This value is currently "read replication."

Normal — (Boolean)

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

Status — (String)

Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message — (String)

Details of the error if there is an error for the instance. If the instance 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 AWS KMS key identifier for the encrypted DB instance.

DbiResourceId — (String)

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

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.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

MonitoringInterval — (Integer)

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

EnhancedMonitoringResourceArn — (String)

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

MonitoringRoleArn — (String)

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

PromotionTier — (Integer)

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

DBInstanceArn — (String)

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

Timezone — (String)

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

IAMDatabaseAuthenticationEnabled — (Boolean)

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

IAM database authentication can be enabled for the following database engines

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

Must match the identifier of an existing DBInstance.

FilenameContains — (String)

Filters the available log files for log file names that contain the specified string.

FileLastWritten — (Integer)

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

FileSize — (Integer)

Filters the available log files for files larger than the specified size.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

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.

If supplied, must match the name of an existing DBClusterParameterGroup.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

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.

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.

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.

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

Parameters:

err(Error)
—

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

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

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

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

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

IncludeShared — (Boolean)

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

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)

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

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

Parameters:

err(Error)
—

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

data(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 gibibytes (GiB).

Status — (String)

Specifies the status of this DB snapshot.

Port — (Integer)

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

AvailabilityZone — (String)

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

VpcId — (String)

Provides the VPC ID associated with the DB snapshot.

InstanceCreateTime — (Date)

Specifies the time 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 AWS Region that the DB snapshot was created in or copied from.

SourceDBSnapshotIdentifier — (String)

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has 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 AWS 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, and otherwise false.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DbiResourceId — (String)

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

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.

The name of the DB cluster parameter group family to return engine parameter information for.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

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

Parameters:

err(Error)
—

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

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

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.

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

Parameters:

err(Error)
—

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

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

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.

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.

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

If the source type is 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.

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

SourceType — (String)

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

Possible values include:

"db-instance"

"db-parameter-group"

"db-security-group"

"db-snapshot"

"db-cluster"

"db-cluster-snapshot"

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.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

The name of the RDS event notification subscription you want to describe.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

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

Parameters:

err(Error)
—

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

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

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

Filters — (Array<map>)

A filter that specifies one or more global 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.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

Marker — (String)

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

GlobalClusters — (Array<map>)

The list of global clusters returned by this request.

GlobalClusterIdentifier — (String)

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

GlobalClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

GlobalClusterArn — (String)

The Amazon Resource Name (ARN) for the global database cluster.

Status — (String)

Specifies the current state of this global database cluster.

Engine — (String)

The Aurora database engine used by the global database cluster.

EngineVersion — (String)

Indicates the database engine version.

DatabaseName — (String)

The default database name within the new global database cluster.

StorageEncrypted — (Boolean)

The storage encryption setting for the global database cluster.

DeletionProtection — (Boolean)

The deletion protection setting for the new global database cluster.

GlobalClusterMembers — (Array<map>)

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

DBClusterArn — (String)

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

Readers — (Array<String>)

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

IsWriter — (Boolean)

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

A required parameter. Options available for the given engine name are 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.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

OptionGroupOptions — (Array<map>)

List of available option group options.

Name — (String)

The name of the option.

Description — (String)

The description of the option.

EngineName — (String)

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

MajorEngineVersion — (String)

Indicates the major engine version that the option is available for.

MinimumRequiredMinorEngineVersion — (String)

The minimum required engine version for the option to be applied.

PortRequired — (Boolean)

Specifies whether the option requires a port.

DefaultPort — (Integer)

If the option requires a port, specifies the default port for the option.

OptionsDependedOn — (Array<String>)

The options that are prerequisites for this option.

OptionsConflictsWith — (Array<String>)

The options that conflict with this option.

Persistent — (Boolean)

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

Permanent — (Boolean)

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

RequiresAutoMinorEngineVersionUpgrade — (Boolean)

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

VpcOnly — (Boolean)

If true, you can only use this option with a DB instance that is in a VPC.

SupportsOptionVersionDowngrade — (Boolean)

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

OptionGroupOptionSettings — (Array<map>)

The option settings that are available (and the default value) for each option in an option group.

SettingName — (String)

The name of the option group option.

SettingDescription — (String)

The description of the option group option.

DefaultValue — (String)

The default value for the option group option.

ApplyType — (String)

The DB engine specific parameter type for the option group option.

AllowedValues — (String)

Indicates the acceptable values for the option group option.

IsModifiable — (Boolean)

Boolean value where true indicates that this option group option can be changed from the default value.

IsRequired — (Boolean)

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

MinimumEngineVersionPerAllowedValue — (Array<map>)

The minimum DB engine version required for the corresponding allowed value for this option setting.

AllowedValue — (String)

The allowed value for an option setting.

MinimumEngineVersion — (String)

The minimum DB engine version required for the allowed value.

OptionGroupOptionVersions — (Array<map>)

The versions that are available for the option.

Version — (String)

The version of the option.

IsDefault — (Boolean)

True if the version is the default version of the option, and otherwise false.

Marker — (String)

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

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

Marker — (String)

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

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

Parameters:

err(Error)
—

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

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

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)

A value that indicates whether to show only VPC or non-VPC offerings.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Marker — (String)

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

A list of the available processor features for the DB instance class of a DB instance.

Name — (String)

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

DefaultValue — (String)

The default value for the processor feature of the DB instance class.

AllowedValues — (String)

The allowed values for the processor feature of the DB instance class.

SupportedEngineModes — (Array<String>)

A list of the supported DB engine modes.

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 .

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

Name — required — (String)

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

Values — required — (Array<String>)

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

Marker — (String)

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

MaxRecords — (Integer)

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

PendingMaintenanceActions — (Array<map>)

A list of the pending maintenance actions for the resource.

ResourceIdentifier — (String)

The ARN of the resource that has pending maintenance actions.

PendingMaintenanceActionDetails — (Array<map>)

A list that provides details about the pending maintenance actions for the resource.

Action — (String)

The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, and hardware-maintenance.

AutoAppliedAfterDate — (Date)

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

ForcedApplyDate — (Date)

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

OptInStatus — (String)

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

CurrentApplyDate — (Date)

The effective date when the pending maintenance action is applied to the resource. 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.

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

ReservedDBInstancesOfferingId — (String)

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

DBInstanceClass — (String)

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Duration — (String)

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

ProductDescription — (String)

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

OfferingType — (String)

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

MultiAZ — (Boolean)

A value that indicates whether to show only those reservations that support Multi-AZ.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

The maximum number of records to include in the response. If more 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.

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

DBInstanceClass — (String)

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Duration — (String)

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

ProductDescription — (String)

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

Note: The results show offerings that partially match the filter value.

OfferingType — (String)

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

MultiAZ — (Boolean)

A value that indicates whether to show only those reservations that support Multi-AZ.

Filters — (Array<map>)

This parameter is not currently supported.

Name — required — (String)

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

Values — required — (Array<String>)

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

MaxRecords — (Integer)

The maximum number of records to include in the response. If more 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.

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.

Name — required — (String)

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

Values — required — (Array<String>)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

ValidDBInstanceModificationsMessage — (map)

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

Storage — (Array<map>)

Valid storage options for your DB instance.

StorageType — (String)

The valid storage types for your DB instance. For example, gp2, io1.

StorageSize — (Array<map>)

The valid range of storage in gibibytes. For example, 100 to 16384.

From — (Integer)

The minimum value in the range.

To — (Integer)

The maximum value in the range.

Step — (Integer)

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

ProvisionedIops — (Array<map>)

The valid range of provisioned IOPS. For example, 1000-20000.

From — (Integer)

The minimum value in the range.

To — (Integer)

The maximum value in the range.

Step — (Integer)

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

IopsToStorageRatio — (Array<map>)

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

From — (Float)

The minimum value in the range.

To — (Float)

The maximum value in the range.

ValidProcessorFeatures — (Array<map>)

Valid processor features for your DB instance.

Name — (String)

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

DefaultValue — (String)

The default value for the processor feature of the DB instance class.

AllowedValues — (String)

The allowed values for the processor feature of the DB instance class.

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

Must match the identifier of an existing DBInstance.

LogFileName — (String)

The name of the log file to be downloaded.

Marker — (String)

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

NumberOfLines — (Integer)

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

If NumberOfLines is specified and Marker 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.

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.

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

CharacterSetName — (String)

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

DatabaseName — (String)

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

DBClusterIdentifier — (String)

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

DBClusterParameterGroup — (String)

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

DBSubnetGroup — (String)

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

Status — (String)

Specifies the current state of this DB cluster.

PercentProgress — (String)

Specifies the progress of the operation as a percentage.

EarliestRestorableTime — (Date)

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

Endpoint — (String)

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

ReaderEndpoint — (String)

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

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

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)

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

DBClusterParameterGroupStatus — (String)

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

PromotionTier — (Integer)

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

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

HostedZoneId — (String)

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

StorageEncrypted — (Boolean)

Specifies whether the DB cluster is encrypted.

KmsKeyId — (String)

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

DbClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.

FeatureName — (String)

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled — (Boolean)

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

CloneGroupId — (String)

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

ClusterCreateTime — (Date)

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

EarliestBacktrackTime — (Date)

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

BacktrackWindow — (Integer)

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

BacktrackConsumedChangeRecords — (Integer)

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports — (Array<String>)

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

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

Capacity — (Integer)

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

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

MaxCapacity — (Integer)

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

AutoPause — (Boolean)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

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

SecondsUntilAutoPause — (Integer)

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

TimeoutAction — (String)

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

DeletionProtection — (Boolean)

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

HttpEndpointEnabled — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

TagList — (Array<map>)

List of tags returned by the ListTagsForResource operation.

Key — (String)

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Value — (String)

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Set the capacity of an Aurora Serverless DB cluster to a specific value.

Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

NewDBClusterIdentifier — (String)

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

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

The first character must be a letter

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

Example: my-cluster2

ApplyImmediately — (Boolean)

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

BackupRetentionPeriod — (Integer)

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

DBClusterParameterGroupName — (String)

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

VpcSecurityGroupIds — (Array<String>)

A list of VPC security groups that the DB cluster will belong to.

Port — (Integer)

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

MasterUserPassword — (String)

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

OptionGroupName — (String)

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

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

PreferredBackupWindow — (String)

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

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

BacktrackWindow — (Integer)

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

Default: 0

Constraints:

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

CloudwatchLogsExportConfiguration — (map)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

EnableLogTypes — (Array<String>)

The list of log types to enable.

DisableLogTypes — (Array<String>)

The list of log types to disable.

EngineVersion — (String)

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

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

EnableHttpEndpoint — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

CharacterSetName — (String)

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

DatabaseName — (String)

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

DBClusterIdentifier — (String)

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

DBClusterParameterGroup — (String)

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

DBSubnetGroup — (String)

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

Status — (String)

Specifies the current state of this DB cluster.

PercentProgress — (String)

Specifies the progress of the operation as a percentage.

EarliestRestorableTime — (Date)

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

Endpoint — (String)

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

ReaderEndpoint — (String)

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

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

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)

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

DBClusterParameterGroupStatus — (String)

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

PromotionTier — (Integer)

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

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

HostedZoneId — (String)

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

StorageEncrypted — (Boolean)

Specifies whether the DB cluster is encrypted.

KmsKeyId — (String)

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

DbClusterResourceId — (String)

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.

FeatureName — (String)

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

IAMDatabaseAuthenticationEnabled — (Boolean)

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

CloneGroupId — (String)

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

ClusterCreateTime — (Date)

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

EarliestBacktrackTime — (Date)

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

BacktrackWindow — (Integer)

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

BacktrackConsumedChangeRecords — (Integer)

The number of change records stored for Backtrack.

EnabledCloudwatchLogsExports — (Array<String>)

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

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

Capacity — (Integer)

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

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

MaxCapacity — (Integer)

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

AutoPause — (Boolean)

A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

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

SecondsUntilAutoPause — (Integer)

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

TimeoutAction — (String)

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

DeletionProtection — (Boolean)

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

HttpEndpointEnabled — (Boolean)

Note: HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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

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

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

EndpointType — (String)

The type of the endpoint. One of: READER, ANY.

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBClusterEndpointIdentifier — (String)

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

DBClusterIdentifier — (String)

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

DBClusterEndpointResourceIdentifier — (String)

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

Endpoint — (String)

The DNS address of the endpoint.

Status — (String)

The current status of the endpoint. One of: creating, available, deleting, modifying.

EndpointType — (String)

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

CustomEndpointType — (String)

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

StaticMembers — (Array<String>)

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

ExcludedMembers — (Array<String>)

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

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.

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

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.

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.

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

Parameters:

err(Error)
—

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

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

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

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

Constraints:

Must match the identifier of an existing DBInstance.

AllocatedStorage — (Integer)

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

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

DBInstanceClass — (String)

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

DBSubnetGroupName — (String)

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance 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 in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

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

Example: mySubnetGroup

DBSecurityGroups — (Array<String>)

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

If supplied, must match existing DBSecurityGroups.

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.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

If supplied, must match existing VpcSecurityGroupIds.

ApplyImmediately — (Boolean)

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

MasterUserPassword — (String)

The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Note: Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

DBParameterGroupName — (String)

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. 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 enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

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 or later

Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

Can't be set to 0 if the DB instance is a source to Read Replicas

PreferredBackupWindow — (String)

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

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

Must be in Universal Time Coordinated (UTC)

Must not conflict with the preferred maintenance window

Must be at least 30 minutes

PreferredMaintenanceWindow — (String)

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

MultiAZ — (Boolean)

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

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 eanbled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

AllowMajorVersionUpgrade — (Boolean)

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

AutoMinorVersionUpgrade — (Boolean)

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

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

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

OptionGroupName — (String)

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

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

NewDBInstanceIdentifier — (String)

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

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

The first character must be a letter.

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

Example: mydbinstance

StorageType — (String)

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

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

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

TdeCredentialArn — (String)

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

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)

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

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.

MonitoringInterval — (Integer)

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. 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.

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

MonitoringRoleArn — (String)

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

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

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

Default: 1

Valid Values: 0 - 15

EnableIAMDatabaseAuthentication — (Boolean)

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

You can enable IAM database authentication for the following database engines

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

For MySQL 5.6, minor version 5.6.34 or higher

For MySQL 5.7, minor version 5.7.16 or higher

EnablePerformanceInsights — (Boolean)

A value that indicates whether to enable Performance Insights for the DB instance.

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

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.

PerformanceInsightsRetentionPeriod — (Integer)

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

CloudwatchLogsExportConfiguration — (map)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

EnableLogTypes — (Array<String>)

The list of log types to enable.

DisableLogTypes — (Array<String>)

The list of log types to disable.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

UseDefaultProcessorFeatures — (Boolean)

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

DeletionProtection — (Boolean)

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

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBInstance — (map)

Contains the details of an Amazon RDS DB instance.

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

DBInstanceIdentifier — (String)

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

DBInstanceClass — (String)

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

Engine — (String)

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.

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

InstanceCreateTime — (Date)

Provides the date and time the DB instance was created.

PreferredBackupWindow — (String)

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

BackupRetentionPeriod — (Integer)

Specifies the number of days for which automatic DB snapshots are retained.

DBSecurityGroups — (Array<map>)

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

DBSecurityGroupName — (String)

The name of the DB security group.

Status — (String)

The status of the DB security group.

VpcSecurityGroups — (Array<map>)

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

VpcSecurityGroupId — (String)

The name of the VPC security group.

Status — (String)

The status of the VPC security group.

DBParameterGroups — (Array<map>)

Provides the list of DB parameter groups applied to this DB instance.

DBParameterGroupName — (String)

The name of the 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 OrderableDBInstanceOption 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 currently being applied.

AllocatedStorage — (Integer)

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

MasterUserPassword — (String)

Contains the pending or currently-in-progress change of the master credentials for the 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.

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

DBInstanceIdentifier — (String)

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

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.

PendingCloudwatchLogsExports — (map)

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

LogTypesToEnable — (Array<String>)

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

LogTypesToDisable — (Array<String>)

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

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

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 to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Note: Currently, each RDS DB instance can have only one Aurora Read Replica.

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.

StatusInfos — (Array<map>)

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

StatusType — (String)

This value is currently "read replication."

Normal — (Boolean)

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

Status — (String)

Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

Message — (String)

Details of the error if there is an error for the instance. If the instance 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 AWS KMS key identifier for the encrypted DB instance.

DbiResourceId — (String)

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

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.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

MonitoringInterval — (Integer)

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

EnhancedMonitoringResourceArn — (String)

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

MonitoringRoleArn — (String)

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

PromotionTier — (Integer)

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

DBInstanceArn — (String)

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

Timezone — (String)

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

IAMDatabaseAuthenticationEnabled — (Boolean)

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

IAM database authentication can be enabled for the following database engines

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.

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"

SupportedEngineModes — (Array<String>)

The valid DB engine modes.

Callback (callback):

function(err, data) { ... }

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

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

5.5.46 (supported for 5.1 DB snapshots)

Oracle

12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

OptionGroupName — (String)

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.

Callback (callback):

function(err, data) { ... }

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

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

Parameters:

err(Error)
—

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

data(Object)
—

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

DBSnapshot — (map)

Contains the details of an Amazon RDS DB snapshot.

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

DBSnapshotIdentifier — (String)

Specifies the identifier for the DB snapshot.

DBInstanceIdentifier — (String)

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

SnapshotCreateTime — (Date)

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 gibibytes (GiB).

Status — (String)

Specifies the status of this DB snapshot.

Port — (Integer)

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

AvailabilityZone — (String)

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

VpcId — (String)

Provides the VPC ID associated with the DB snapshot.

InstanceCreateTime — (Date)

Specifies the time 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 AWS Region that the DB snapshot was created in or copied from.

SourceDBSnapshotIdentifier — (String)

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has 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 AWS 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, and otherwise false.

ProcessorFeatures — (Array<map>)

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

Name — (String)

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

Value — (String)

The value of a processor feature name.

DbiResourceId — (String)

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

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.

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.

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

Parameters:

err(Error)
—

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

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

Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

SourceType — (String)

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

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 value that indicates whether to activate the subscription.

Callback (callback):

function(err, data) { ... }

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

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.