String dBClusterIdentifier
The name of the DB cluster to associate the IAM role with.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.
String featureName
The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
String dBInstanceIdentifier
The name of the DB instance to associate the IAM role with.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example
arn:aws:iam::123456789012:role/AccessRole
.
String featureName
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
String subscriptionName
The name of the RDS event notification subscription you want to add a source identifier to.
String sourceIdentifier
The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, a DBInstanceIdentifier
value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier
value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier
value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
value must be supplied.
If the source type is an RDS Proxy, a DBProxyName
value must be supplied.
String resourceName
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
SdkInternalList<T> tags
The tags to be assigned to the Amazon RDS resource.
String resourceIdentifier
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
String applyAction
The pending maintenance action to apply to this resource.
Valid values: system-update
, db-upgrade
, hardware-maintenance
,
ca-certificate-rotation
String optInType
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type
immediate
can't be undone.
Valid values:
immediate
- Apply the maintenance action immediately.
next-maintenance
- Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in
- Cancel any existing next-maintenance
opt-in requests.
String dBSecurityGroupName
The name of the DB security group to add authorization to.
String cIDRIP
The IP range to authorize.
String eC2SecurityGroupName
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.
String eC2SecurityGroupId
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.
String eC2SecurityGroupOwnerId
Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn't an acceptable value. For
VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise,
EC2SecurityGroupOwnerId
and either EC2SecurityGroupName
or
EC2SecurityGroupId
must be provided.
String name
The name of the Availability Zone.
String name
The name of the processor feature. Valid names are coreCount
and threadsPerCore
.
String defaultValue
The default value for the processor feature of the DB instance class.
String allowedValues
The allowed values for the processor feature of the DB instance class.
String dBClusterIdentifier
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
Date backtrackTo
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.
If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
Must contain a valid ISO 8601 timestamp.
Can't contain a timestamp set in the future.
Example: 2017-07-08T18:00Z
Boolean force
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.
Boolean useEarliestTimeOnPointInTimeUnavailable
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.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String backtrackIdentifier
Contains the backtrack identifier.
Date backtrackTo
The timestamp of the time to which the DB cluster was backtracked.
Date backtrackedFrom
The timestamp of the time from which the DB cluster was backtracked.
Date backtrackRequestCreationTime
The timestamp of the time at which the backtrack was requested.
String status
The status of the backtrack. This property returns one of the following values:
applying
- The backtrack is currently being applied to or rolled back from the DB cluster.
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster.
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending
- The backtrack is currently pending application to or rollback from the DB cluster.
String blueGreenDeploymentIdentifier
The unique identifier of the blue/green deployment.
String blueGreenDeploymentName
The user-supplied name of the blue/green deployment.
String source
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
String target
The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
SdkInternalList<T> switchoverDetails
The details about each source and target resource in the blue/green deployment.
SdkInternalList<T> tasks
Either tasks to be performed or tasks that have been completed on the target database before switchover.
String status
The status of the blue/green deployment.
Valid Values:
PROVISIONING
- Resources are being created in the green environment.
AVAILABLE
- Resources are available in the green environment.
SWITCHOVER_IN_PROGRESS
- The deployment is being switched from the blue environment to the green
environment.
SWITCHOVER_COMPLETED
- Switchover from the blue environment to the green environment is complete.
INVALID_CONFIGURATION
- Resources in the green environment are invalid, so switchover isn't
possible.
SWITCHOVER_FAILED
- Switchover was attempted but failed.
DELETING
- The blue/green deployment is being deleted.
String statusDetails
Additional information about the status of the blue/green deployment.
Date createTime
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
Date deleteTime
The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
SdkInternalList<T> tagList
String name
The name of the blue/green deployment task.
String status
The status of the blue/green deployment task.
Valid Values:
PENDING
- The resource is being prepared for deployment.
IN_PROGRESS
- The resource is being deployed.
COMPLETED
- The resource has been deployed.
FAILED
- Deployment of the resource failed.
String exportTaskIdentifier
The identifier of the snapshot or cluster export task to cancel.
String exportTaskIdentifier
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
String sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
SdkInternalList<T> exportOnly
The data exported from the snapshot or cluster. Valid values are the following:
database
- Export all the data from a specified database.
database.table
table-name - Export a table of the snapshot or cluster. This format is valid
only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema
schema-name - Export a database schema of the snapshot or cluster. This
format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table
table-name - Export a table of the database schema. This format is
valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Date snapshotTime
The time that the snapshot was created.
Date taskStartTime
The time that the snapshot or cluster export task started.
Date taskEndTime
The time that the snapshot or cluster export task ended.
String s3Bucket
The Amazon S3 bucket that the snapshot or cluster is exported to.
String s3Prefix
The Amazon S3 bucket prefix that is the file name and path of the exported data.
String iamRoleArn
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
String kmsKeyId
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
String status
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
Integer percentProgress
The progress of the snapshot or cluster export task as a percentage.
Integer totalExtractedDataInGB
The total amount of data exported, in gigabytes.
String failureCause
The reason the export failed, if it failed.
String warningMessage
A warning about the snapshot or cluster export task.
String sourceType
The type of source for the export.
String certificateIdentifier
The unique key that identifies a certificate.
String certificateType
The type of the certificate.
String thumbprint
The thumbprint of the certificate.
Date validFrom
The starting date from which the certificate is valid.
Date validTill
The final date that the certificate continues to be valid.
String certificateArn
The Amazon Resource Name (ARN) for the certificate.
Boolean customerOverride
Whether there is an override for the default certificate identifier.
Date customerOverrideValidTill
If there is an override for the default certificate identifier, when the override expires.
SdkInternalList<T> enableLogTypes
The list of log types to enable.
SdkInternalList<T> disableLogTypes
The list of log types to disable.
PendingCloudwatchLogsExports pendingCloudwatchLogsExports
String dBClusterIdentifier
The DBClusterIdentifier value for the DB cluster.
String masterUserPassword
The master credentials for the DB cluster.
Boolean iAMDatabaseAuthenticationEnabled
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
String engineVersion
The database engine version.
Integer backupRetentionPeriod
The number of days for which automatic DB snapshots are retained.
Integer allocatedStorage
The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora,
AllocatedStorage
always returns 1, because Aurora DB cluster storage size isn't fixed, but instead
automatically adjusts as needed.
Integer iops
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
String storageType
The storage type for the DB cluster.
Integer maxConnectionsPercent
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage
of the max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target
group.
If you specify MaxIdleConnectionsPercent
, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints: Must be between 1 and 100.
Integer maxIdleConnectionsPercent
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed
as a percentage of the max_connections
setting for the RDS DB instance or Aurora DB cluster used by
the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low
value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent
.
Default: The default value is half of the value of MaxConnectionsPercent
. For example, if
MaxConnectionsPercent
is 80, then the default value of MaxIdleConnectionsPercent
is 40.
If the value of MaxConnectionsPercent
isn't specified, then for SQL Server,
MaxIdleConnectionsPercent
is 5, and for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent
.
Integer connectionBorrowTimeout
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
SdkInternalList<T> sessionPinningFilters
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
String initQuery
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with
SET
statements to make sure that each connection has identical settings such as time zone and
character set. For multiple statements, use semicolons as the separator. You can also include multiple variables
in a single SET
statement, such as SET x=1, y=2
.
Default: no initialization query
Integer maxConnectionsPercent
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage
of the max_connections
setting for the RDS DB instance or Aurora DB cluster used by the target
group.
Integer maxIdleConnectionsPercent
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed
as a percentage of the max_connections
setting for the RDS DB instance or Aurora DB cluster used by
the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low
value causes the proxy to close more idle connections and return them to the database.
Integer connectionBorrowTimeout
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
SdkInternalList<T> sessionPinningFilters
Each item in the list represents a class of SQL operations that normally cause all later statements in a session
using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that
class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family
databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS
.
String initQuery
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with
SET
statements to make sure that each connection has identical settings such as time zone and
character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You
can also include multiple variables in a single SET
statement, such as SET x=1, y=2
.
String sourceDBClusterParameterGroupIdentifier
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.
String targetDBClusterParameterGroupIdentifier
The identifier for the copied DB cluster parameter group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
String targetDBClusterParameterGroupDescription
A description for the copied DB cluster parameter group.
SdkInternalList<T> tags
String sourceDBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster-snapshot2
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for
KmsKeyId
to encrypt the copy with a new KMS key. If you don't specify a value for
KmsKeyId
, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source
DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you
must specify a value for KmsKeyId
.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set
KmsKeyId
to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB
cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services
Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon
Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId
parameter, an
error is returned.
String preSignedUrl
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL
that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot
API operation in
the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the
PreSignedUrl
parameter when copying an encrypted DB cluster snapshot from another Amazon Web
Services Region. Don't specify PreSignedUrl
when copying an encrypted DB cluster snapshot in the
same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot
API operation that can run
in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned
URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster
snapshot in the destination Amazon Web Services Region. This is the same identifier for both the
CopyDBClusterSnapshot
operation that is called in the destination Amazon Web Services Region, and
the operation contained in the presigned URL.
DestinationRegion
- The name of the Amazon Web Services Region that the DB cluster snapshot is to be
created in.
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web
Services Region, then your SourceDBClusterSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in
the source Amazon Web Services Region.
Boolean copyTags
A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
SdkInternalList<T> tags
String sourceRegion
String sourceDBParameterGroupIdentifier
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
String targetDBParameterGroupIdentifier
The identifier for the copied DB parameter group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-db-parameter-group
String targetDBParameterGroupDescription
A description for the copied DB parameter group.
SdkInternalList<T> tags
String sourceDBSnapshotIdentifier
The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot
identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805
.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot
ARN. For example, you might specify
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
.
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Must specify a valid system snapshot in the "available" state.
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
String targetDBSnapshotIdentifier
The identifier for the copy of the snapshot.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-db-snapshot
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
SdkInternalList<T> tags
Boolean copyTags
A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
String preSignedUrl
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that
contains a Signature Version 4 signed request for the CopyDBSnapshot
API operation in the source
Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by
using the Amazon RDS API. Don't specify PreSignedUrl
when you are copying an encrypted DB snapshot
in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot
API operation that can run
in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned
URL request must contain the following parameter values:
DestinationRegion
- The Amazon Web Services Region that the encrypted DB snapshot is copied to. This
Amazon Web Services Region is the same one where the CopyDBSnapshot
operation is called that
contains this presigned URL.
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1
Amazon Web Services Region, then you call the CopyDBSnapshot
operation in the us-east-1 Amazon Web
Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot
operation in
the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion
in the presigned
URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in
the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot
operation that is called in the destination Amazon Web Services Region, and the operation contained in the
presigned URL.
SourceDBSnapshotIdentifier
- The DB snapshot identifier for the encrypted snapshot to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your
SourceDBSnapshotIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in
the source Amazon Web Services Region.
String optionGroupName
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
String targetCustomAvailabilityZone
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv
.
Boolean copyOptionGroup
A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
String sourceRegion
String sourceOptionGroupIdentifier
The identifier for the source option group.
Constraints:
Must specify a valid option group.
String targetOptionGroupIdentifier
The identifier for the copied option group.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-option-group
String targetOptionGroupDescription
The description for the copied option group.
SdkInternalList<T> tags
String blueGreenDeploymentName
The name of the blue/green deployment.
Constraints:
Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
String source
The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
String targetEngineVersion
The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
String targetDBParameterGroupName
The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
String targetDBClusterParameterGroupName
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
SdkInternalList<T> tags
Tags to assign to the blue/green deployment.
BlueGreenDeployment blueGreenDeployment
String engine
The database engine to use for your custom engine version (CEV). The only supported value is
custom-oracle-ee
.
String engineVersion
The name of your CEV. The name format is 19.customized_string. For example, a valid CEV name is
19.my_cev1
. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The
combination of Engine
and EngineVersion
is unique per customer per Region.
String databaseInstallationFilesS3BucketName
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid
bucket name is my-custom-installation-files
.
String databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket
name is 123456789012/cev1
. If this setting isn't specified, no prefix is assumed.
String imageId
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
String kMSKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
String description
An optional description of your CEV.
String manifest
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
Version of the CEV manifest. The date is in the format YYYY-MM-DD
.
Ordered list of installation files for the CEV.
Ordered list of OPatch installers used for the Oracle DB engine.
The PSU and RU patches for this CEV.
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
SdkInternalList<T> tags
String sourceCustomDbEngineVersionIdentifier
Reserved for future use.
Boolean useAwsProvidedLatestImage
Reserved for future use.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API isn't specified.
CustomDBEngineVersionAMI image
The EC2 image
String dBEngineMediaType
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName
parameter of the
CreateDBInstance
operation.
SdkInternalList<T> supportedNcharCharacterSets
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
parameter of the CreateDBInstance
operation.
SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone
parameter of the
CreateDBInstance
action.
SdkInternalList<T> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports read replicas.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
SdkInternalList<T> supportedFeatureNames
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames
in the output.
String status
The status of the DB engine version, either available
or deprecated
.
Boolean supportsParallelQuery
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
String majorEngineVersion
The major engine version of the CEV.
String databaseInstallationFilesS3BucketName
The name of the Amazon S3 bucket that contains your database installation files.
String databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
String dBEngineVersionArn
The ARN of the custom engine version.
String kMSKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
Date createTime
The creation time of the DB engine version.
SdkInternalList<T> tagList
Boolean supportsBabelfish
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
String customDBEngineVersionManifest
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
Boolean supportsCertificateRotationWithoutRestart
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SdkInternalList<T> supportedCACertificateIdentifiers
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Boolean supportsLocalWriteForwarding
A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
String endpointType
The type of the endpoint, one of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
SdkInternalList<T> tags
The tags to be assigned to the Amazon RDS resource.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating
, available
, deleting
,
inactive
, modifying
. The inactive
state applies to an endpoint that can't
be used for a certain kind of cluster, such as a writer
endpoint for a read-only secondary cluster
in a global database.
String endpointType
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
String customEndpointType
The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
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.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7
, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
String description
The description for the DB cluster parameter group.
SdkInternalList<T> tags
Tags to assign to the DB cluster parameter group.
SdkInternalList<T> availabilityZones
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Integer backupRetentionPeriod
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
String characterSetName
The name of the character set (CharacterSet
) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
String databaseName
The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String dBClusterIdentifier
The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String dBSubnetGroupName
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default
.
Example: mydbsubnetgroup
String engine
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
String engineVersion
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7
or 8.0
to use the default engine version for Aurora MySQL
version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Integer port
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
String masterUsername
The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
String optionGroupName
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
String replicationSourceIdentifier
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
SdkInternalList<T> tags
Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId
:
If ReplicationSourceIdentifier
identifies an encrypted source, then Amazon RDS uses the KMS key used
to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted
parameter is enabled and ReplicationSourceIdentifier
isn't
specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set
KmsKeyId
to a KMS key identifier that is valid in the destination Amazon Web Services Region. This
KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String preSignedUrl
When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that
contains a Signature Version 4 signed request for the CreateDBCluster
operation to be called in the
source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl
only
when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster
API operation that can run in the
source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId
- The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in
the destination Amazon Web Services Region. This should refer to the same KMS key for both the
CreateDBCluster
operation that is called in the destination Amazon Web Services Region, and the
operation contained in the presigned URL.
DestinationRegion
- The name of the Amazon Web Services Region that Aurora read replica will be
created in.
ReplicationSourceIdentifier
- The DB cluster identifier for the encrypted DB cluster to be copied.
This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your
ReplicationSourceIdentifier
would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in
the source Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters only
Boolean enableIAMDatabaseAuthentication
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
String engineMode
The DB engine mode of the DB cluster, either provisioned
or serverless
.
The serverless
engine mode only applies for Aurora Serverless v1 DB clusters.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide:
Valid for Cluster Type: Aurora DB clusters only
ScalingConfiguration scalingConfiguration
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
Boolean deletionProtection
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String globalClusterIdentifier
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
Boolean enableHttpEndpoint
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Boolean copyTagsToSnapshot
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String domain
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
Boolean enableGlobalWriteForwarding
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
String dBClusterInstanceClass
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions, or for
all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer allocatedStorage
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
String storageType
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to aurora-iopt1
, the storage type is
returned in the response. The storage type isn't returned when you set it to aurora
.
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Boolean publiclyAccessible
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Boolean autoMinorVersionUpgrade
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To
turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than
0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
String monitoringRoleArn
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
Boolean enablePerformanceInsights
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration
String networkType
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
String dBSystemId
Reserved for future use.
Boolean manageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean enableLocalWriteForwarding
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String sourceRegion
String dBClusterSnapshotIdentifier
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
String dBClusterIdentifier
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
SdkInternalList<T> tags
The tags to be assigned to the DB cluster snapshot.
String dBInstanceIdentifier
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
String sourceDBInstanceIdentifier
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier
parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
String dBInstanceClass
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits from the source DB instance.
String availabilityZone
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Integer port
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Boolean multiAZ
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 is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits from the source DB instance
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
String optionGroupName
The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.
For SQL Server, you must use the option group associated with the source.
This setting doesn't apply to RDS Custom.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then Amazon RDS uses the
DBParameterGroup
of source DB instance for a same Region read replica, or the default
DBParameterGroup
for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
SdkInternalList<T> tags
String dBSubnetGroupName
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
SdkInternalList<T> vpcSecurityGroupIds
A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String storageType
Specifies the storage type to be associated with the read replica.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
Boolean copyTagsToSnapshot
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.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go
to To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom.
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
String preSignedUrl
When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one
China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica
API operation in the source Amazon Web Services Region that contains the
source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region
by using the Amazon RDS API. Don't specify PreSignedUrl
when you are creating an encrypted read
replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica
API operation that can
run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL
request must contain the following parameter values:
DestinationRegion
- The Amazon Web Services Region that the encrypted read replica is created in.
This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica
operation is
called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB
instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica
operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the
CreateDBInstanceReadReplica
operation in the us-west-2 Amazon Web Services Region. For this example,
the DestinationRegion
in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId
- The KMS key identifier for the key to use to encrypt the read replica in the destination
Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica
operation that is called in the destination Amazon Web Services Region, and the operation contained in the
presigned URL.
SourceDBInstanceIdentifier
- The DB instance identifier for the encrypted DB instance to be
replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services
Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web
Services Region, then your SourceDBInstanceIdentifier
looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in
the source Amazon Web Services Region.
SourceRegion
isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support
cross-Region read replicas.
This setting doesn't apply to RDS Custom.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
Boolean deletionProtection
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 isn't enabled. For more information, see Deleting a DB Instance.
String domain
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
String domainIAMRoleName
The name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
String domainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
String domainOu
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
String domainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
SdkInternalList<T> domainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
String replicaMode
The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to mounted
. The value won't be set by
default. After replica creation, you can manage the open mode manually.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
String customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
String networkType
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for read replica. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Integer storageThroughput
Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora.
Boolean enableCustomerOwnedIp
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
Integer allocatedStorage
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
String sourceDBClusterIdentifier
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can't be specified if the SourceDBInstanceIdentifier
parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
String sourceRegion
String dBName
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, a database
named postgres
is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you don't specify a value, the default value is
ORCL
. You can't specify the string null
, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Can't be longer than 8 characters
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value
is ORCL
for non-CDBs and RDSCDB
for CDBs.
Default: ORCL
Constraints:
It must contain 1 to 8 alphanumeric characters.
It must contain a letter.
It can't be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created.
If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres
is
created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.
String dBInstanceIdentifier
The identifier for this DB instance. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Integer allocatedStorage
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3):
Enterprise and Standard editions: Must be an integer from 20 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 100 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 20 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
String dBInstanceClass
The compute and memory capacity of the DB instance, for example db.m5.large
. Not all DB instance
classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB instance
classes in the Amazon RDS User Guide or Aurora DB
instance classes in the Amazon Aurora User Guide.
String engine
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
aurora-mysql
(for Aurora MySQL DB instances)
aurora-postgresql
(for Aurora PostgreSQL DB instances)
custom-oracle-ee
(for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances)
custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances)
custom-sqlserver-se
(for RDS Custom for SQL Server DB instances)
custom-sqlserver-web
(for RDS Custom for SQL Server DB instances)
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String masterUsername
The name for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@".
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use
the VpcSecurityGroupIds
setting instead.
SdkInternalList<T> vpcSecurityGroupIds
A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String availabilityZone
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Constraints:
The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example: us-east-1d
String dBSubnetGroupName
A DB subnet group to associate with this DB instance.
Constraints:
Must match the name of an existing DB subnet group.
Must not be default
.
Example: mydbsubnetgroup
String preferredMaintenanceWindow
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. Setting this parameter to 0
disables automated backups.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. The default is a 30-minute window selected at random from an 8-hour
block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Integer port
The port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, or 49152-49156
.
Boolean multiAZ
Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
String engineVersion
The version number of the database engine to use.
This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.
For a list of valid engine versions, use the DescribeDBEngineVersions
operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for
Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is
19.my_cev1
. For more information, see
Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide.
For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide.
For information, see Oracle Database Engine release notes in the Amazon RDS User Guide.
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Boolean autoMinorVersionUpgrade
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade
to false
.
String licenseModel
The license model information for this DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Constraints:
For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
String optionGroupName
The option group to associate the DB instance with.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
String characterSetName
For supported engines, the character set (CharacterSet
) to associate the DB instance with.
This setting doesn't apply to the following DB instances:
Amazon Aurora - The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
RDS Custom - However, if you need to change the character set, you can change it on the database itself.
String ncharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
Boolean publiclyAccessible
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
SdkInternalList<T> tags
Tags to assign to the DB instance.
String dBClusterIdentifier
The identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
String storageType
The storage type to associate with the DB instance.
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
Boolean storageEncrypted
Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed
by the DB cluster. For more information, see CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter
empty while enabling StorageEncrypted
, the engine uses the default KMS key. However, RDS Custom
doesn't use the default key when this parameter is empty. You must explicitly specify a key.
String domain
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
String domainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
String domainOu
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
String domainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
SdkInternalList<T> domainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Boolean copyTagsToSnapshot
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, then you must set MonitoringInterval
to a value
other than 0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, then you must supply a
MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom DB instances.
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
Integer promotionTier
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
String timezone
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
Boolean enableIAMDatabaseAuthentication
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
RDS Custom
Boolean enablePerformanceInsights
Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
SdkInternalList<T> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
RDS Custom
The following values are valid for each DB engine:
RDS for MariaDB - audit | error | general | slowquery
RDS for Microsoft SQL Server - agent | error
RDS for MySQL - audit | error | general | slowquery
RDS for Oracle - alert | audit | listener | trace | oemagent
RDS for PostgreSQL - postgresql | upgrade
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Boolean deletionProtection
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the
DB cluster. For more information, see CreateDBCluster
. DB instances in a DB cluster can be deleted
even when deletion protection is enabled for the DB cluster.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
Amazon Aurora (Storage is managed by the DB cluster.)
RDS Custom
Boolean enableCustomerOwnedIp
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
String customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
String backupTarget
The location for storing automated backups and manual snapshots.
Valie Values:
outposts
(Amazon Web Services Outposts)
region
(Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
String networkType
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
Integer storageThroughput
The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Boolean manageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
String cACertificateIdentifier
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
String dBSystemId
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database
files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA)
and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB
. The
Oracle SID is also the name of your CDB.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String description
The description for the DB parameter group.
SdkInternalList<T> tags
Tags to assign to the DB parameter group.
String dBProxyName
The name of the DB proxy associated with the DB proxy endpoint that you create.
String dBProxyEndpointName
The name of the DB proxy endpoint to create.
SdkInternalList<T> vpcSubnetIds
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
SdkInternalList<T> vpcSecurityGroupIds
The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
String targetRole
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The
default is READ_WRITE
. The only role that proxies for RDS for Microsoft SQL Server support is
READ_WRITE
.
SdkInternalList<T> tags
DBProxyEndpoint dBProxyEndpoint
The DBProxyEndpoint
object that is created by the API operation. The DB proxy endpoint that you
create might provide capabilities such as read/write or read-only operations, or using a different VPC than the
proxy's default VPC.
String dBProxyName
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
String engineFamily
The kinds of databases that the proxy can connect to. This value determines which database network protocol the
proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB,
and RDS for MySQL databases, specify MYSQL
. For Aurora PostgreSQL and RDS for PostgreSQL databases,
specify POSTGRESQL
. For RDS for Microsoft SQL Server, specify SQLSERVER
.
SdkInternalList<T> auth
The authorization mechanism that the proxy uses.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
SdkInternalList<T> vpcSubnetIds
One or more VPC subnet IDs to associate with the new proxy.
SdkInternalList<T> vpcSecurityGroupIds
One or more VPC security group IDs to associate with the new proxy.
Boolean requireTLS
A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
Integer idleClientTimeout
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
Boolean debugLogging
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
SdkInternalList<T> tags
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
DBProxy dBProxy
The DBProxy
structure corresponding to the new proxy.
String dBSecurityGroupName
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
String dBSecurityGroupDescription
The description for the DB security group.
SdkInternalList<T> tags
Tags to assign to the DB security group.
String dBSnapshotIdentifier
The identifier for the DB snapshot.
Constraints:
Can't be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String dBInstanceIdentifier
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
SdkInternalList<T> tags
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
Must not be default.
First character must be a letter.
Example: mydbsubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
SdkInternalList<T> subnetIds
The EC2 Subnet IDs for the DB subnet group.
SdkInternalList<T> tags
Tags to assign to the DB subnet group.
String subscriptionName
The name of the subscription.
Constraints: The name must be less than 255 characters.
String snsTopicArn
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.
String sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by
a DB instance, you set this parameter to db-instance
. For RDS Proxy events, specify
db-proxy
. If this value isn't specified, all events are returned.
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
|
db-proxy
SdkInternalList<T> eventCategories
A list of event categories for a particular source type (SourceType
) that you want to subscribe to.
You can see a list of the categories for a given source type in the
"Amazon RDS event categories and event messages" section of the Amazon RDS User
Guide or the Amazon Aurora
User Guide . You can also see this list by using the DescribeEventCategories
operation.
SdkInternalList<T> sourceIds
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds
are supplied, SourceType
must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier
value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier
value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier
value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
value must be supplied.
If the source type is an RDS Proxy, a DBProxyName
value must be supplied.
Boolean enabled
A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
SdkInternalList<T> tags
String globalClusterIdentifier
The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
String sourceDBClusterIdentifier
The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
String engine
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can't be specified if SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the
engine of the source DB cluster.
String engineVersion
The engine version to use for this global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the
engine version of the source DB cluster.
Boolean deletionProtection
Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.
String databaseName
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the
database name from the source DB cluster.
Boolean storageEncrypted
Specifies whether to enable storage encryption for the new global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier
is specified. In this case, Amazon Aurora uses the
setting from the source DB cluster.
String optionGroupName
Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
String engineName
Specifies the name of the engine that this option group should be associated with.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String majorEngineVersion
Specifies the major version of the engine that this option group should be associated with.
String optionGroupDescription
The description of the option group.
SdkInternalList<T> tags
Tags to assign to the option group.
Integer allocatedStorage
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
SdkInternalList<T> availabilityZones
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
Integer backupRetentionPeriod
The number of days for which automatic DB snapshots are retained.
String characterSetName
If present, specifies the name of the character set that this cluster is associated with.
String databaseName
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
String dBClusterIdentifier
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
String dBClusterParameterGroup
The name of the DB cluster parameter group for the DB cluster.
String dBSubnetGroup
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
String status
The current state of this DB cluster.
Date automaticRestartTime
The time when a stopped DB cluster is restarted automatically.
String percentProgress
The progress of the operation as a percentage.
Date earliestRestorableTime
The earliest time to which a database can be restored with point-in-time restore.
String endpoint
The connection endpoint for the primary instance of the DB cluster.
String readerEndpoint
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.
SdkInternalList<T> customEndpoints
The custom endpoints associated with the DB cluster.
Boolean multiAZ
Indicates whether the DB cluster has instances in multiple Availability Zones.
String engine
The database engine used for this DB cluster.
String engineVersion
The version of the database engine.
Date latestRestorableTime
The latest time to which a database can be restored with point-in-time restore.
Integer port
The port that the database engine is listening on.
String masterUsername
The master username for the DB cluster.
SdkInternalList<T> dBClusterOptionGroupMemberships
The list of option group memberships for this DB cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
String replicationSourceIdentifier
The identifier of the source DB cluster if this DB cluster is a read replica.
SdkInternalList<T> readReplicaIdentifiers
Contains one or more identifiers of the read replicas associated with this DB cluster.
SdkInternalList<T> dBClusterMembers
The list of DB instances that make up the DB cluster.
SdkInternalList<T> vpcSecurityGroups
The list of VPC security groups that the DB cluster belongs to.
String hostedZoneId
The ID that Amazon Route 53 assigns when you create a hosted zone.
Boolean storageEncrypted
Indicates whether the DB cluster is encrypted.
String kmsKeyId
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String dbClusterResourceId
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
String dBClusterArn
The Amazon Resource Name (ARN) for the DB cluster.
SdkInternalList<T> associatedRoles
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Boolean iAMDatabaseAuthenticationEnabled
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
String cloneGroupId
The ID of the clone group with which the DB cluster is associated.
Date clusterCreateTime
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Date earliestBacktrackTime
The earliest time to which a DB cluster can be backtracked.
Long backtrackWindow
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the
DB cluster. Otherwise, backtracking is enabled.
Long backtrackConsumedChangeRecords
The number of change records stored for Backtrack.
SdkInternalList<T> enabledCloudwatchLogsExports
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.
Integer capacity
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
String engineMode
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
ScalingConfigurationInfo scalingConfigurationInfo
Boolean deletionProtection
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
Boolean httpEndpointEnabled
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
String activityStreamMode
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
String activityStreamStatus
The status of the database activity stream.
String activityStreamKmsKeyId
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String activityStreamKinesisStreamName
The name of the Amazon Kinesis data stream used for the database activity stream.
Boolean copyTagsToSnapshot
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
Boolean crossAccountClone
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
SdkInternalList<T> domainMemberships
The Active Directory Domain membership records associated with the DB cluster.
SdkInternalList<T> tagList
String globalWriteForwardingStatus
The status of write forwarding for a secondary cluster in an Aurora global database.
Boolean globalWriteForwardingRequested
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the
request has completed before using the write forwarding feature for this cluster.
ClusterPendingModifiedValues pendingModifiedValues
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
String dBClusterInstanceClass
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
String storageType
The storage type associated with the DB cluster.
Integer iops
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Boolean publiclyAccessible
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Boolean autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
Boolean performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration
String networkType
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
String dBSystemId
Reserved for future use.
MasterUserSecret masterUserSecret
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Date iOOptimizedNextAllowedModificationTime
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
String localWriteForwardingStatus
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
String engine
The name of the database engine for this automated backup.
String vpcId
The VPC ID associated with the DB cluster.
String dBClusterAutomatedBackupsArn
The Amazon Resource Name (ARN) for the automated backups.
String dBClusterIdentifier
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow restoreWindow
String masterUsername
The master user name of the automated backup.
String dbClusterResourceId
The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
String region
The Amazon Web Services Region associated with the automated backup.
String licenseModel
The license model information for this DB cluster automated backup.
String status
A list of status information for an automated backup:
retained
- Automated backups for deleted clusters.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Date clusterCreateTime
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Boolean storageEncrypted
Specifies whether the source DB cluster is encrypted.
Integer allocatedStorage
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
String engineVersion
The version of the database engine for the automated backup.
String dBClusterArn
The Amazon Resource Name (ARN) for the source DB cluster.
Integer backupRetentionPeriod
The retention period for the automated backups.
String engineMode
The engine mode of the database engine for the automated backup.
SdkInternalList<T> availabilityZones
The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Integer port
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
String kmsKeyId
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String storageType
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Integer iops
The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String backtrackIdentifier
Contains the backtrack identifier.
Date backtrackTo
The timestamp of the time to which the DB cluster was backtracked.
Date backtrackedFrom
The timestamp of the time from which the DB cluster was backtracked.
Date backtrackRequestCreationTime
The timestamp of the time at which the backtrack was requested.
String status
The status of the backtrack. This property returns one of the following values:
applying
- The backtrack is currently being applied to or rolled back from the DB cluster.
completed
- The backtrack has successfully been applied to or rolled back from the DB cluster.
failed
- An error occurred while the backtrack was applied to or rolled back from the DB cluster.
pending
- The backtrack is currently pending application to or rollback from the DB cluster.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating
, available
, deleting
,
inactive
, modifying
. The inactive
state applies to an endpoint that can't
be used for a certain kind of cluster, such as a writer
endpoint for a read-only secondary cluster
in a global database.
String endpointType
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
String customEndpointType
The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
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.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBInstanceIdentifier
Specifies the instance identifier for this member of the DB cluster.
Boolean isClusterWriter
Value that is true
if the cluster member is the primary instance for the DB cluster and
false
otherwise.
String dBClusterParameterGroupStatus
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
Integer promotionTier
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.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
String dBParameterGroupFamily
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
String description
Provides the customer-specified description for this DB cluster parameter group.
String dBClusterParameterGroupArn
The Amazon Resource Name (ARN) for the DB cluster parameter group.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
String status
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB cluster and can be used to access other Amazon
Web Services on your behalf.
PENDING
- the IAM role ARN is being associated with the DB cluster.
INVALID
- the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume
the IAM role in order to access other Amazon Web Services on your behalf.
String featureName
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
SdkInternalList<T> availabilityZones
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
String dBClusterSnapshotIdentifier
Specifies the identifier for the DB cluster snapshot.
String dBClusterIdentifier
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String engine
Specifies the name of the database engine for this DB cluster snapshot.
String engineMode
Provides the engine mode of the database engine for this DB cluster snapshot.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Integer port
Specifies the port that the DB cluster was listening on at the time of the snapshot.
String vpcId
Provides the VPC ID associated with the DB cluster snapshot.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master username for this DB cluster snapshot.
String engineVersion
Provides the version of the database engine for this DB cluster snapshot.
String licenseModel
Provides the license model information for this DB cluster snapshot.
String snapshotType
Provides the type of the DB cluster snapshot.
Integer percentProgress
Specifies the percentage of the estimated data that has been transferred.
Boolean storageEncrypted
Specifies whether the DB cluster snapshot is encrypted.
String kmsKeyId
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster
snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String dBClusterSnapshotArn
Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.
String sourceDBClusterSnapshotArn
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.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
SdkInternalList<T> tagList
String dBSystemId
Reserved for future use.
String storageType
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
String dbClusterResourceId
Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.
String attributeName
The name of the manual DB cluster snapshot attribute.
The attribute named restore
refers to the list of Amazon Web Services accounts that have permission
to copy or restore the manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.
SdkInternalList<T> attributeValues
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName
field is set to restore
, then this element returns a list of IDs
of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a
value of all
is in the list, then the manual DB cluster snapshot is public and available for any
Amazon Web Services account to copy or restore.
String dBClusterSnapshotIdentifier
The identifier of the manual DB cluster snapshot that the attributes apply to.
SdkInternalList<T> dBClusterSnapshotAttributes
The list of attributes and values for the manual DB cluster snapshot.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API isn't specified.
CustomDBEngineVersionAMI image
The EC2 image
String dBEngineMediaType
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName
parameter of the
CreateDBInstance
operation.
SdkInternalList<T> supportedNcharCharacterSets
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
parameter of the CreateDBInstance
operation.
SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone
parameter of the
CreateDBInstance
action.
SdkInternalList<T> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports read replicas.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
SdkInternalList<T> supportedFeatureNames
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames
in the output.
String status
The status of the DB engine version, either available
or deprecated
.
Boolean supportsParallelQuery
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
String majorEngineVersion
The major engine version of the CEV.
String databaseInstallationFilesS3BucketName
The name of the Amazon S3 bucket that contains your database installation files.
String databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
String dBEngineVersionArn
The ARN of the custom engine version.
String kMSKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
Date createTime
The creation time of the DB engine version.
SdkInternalList<T> tagList
Boolean supportsBabelfish
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
String customDBEngineVersionManifest
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
Boolean supportsCertificateRotationWithoutRestart
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SdkInternalList<T> supportedCACertificateIdentifiers
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Boolean supportsLocalWriteForwarding
A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String dBInstanceIdentifier
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
String dBInstanceClass
The name of the compute and memory capacity class of the DB instance.
String engine
The database engine used for this DB instance.
String dBInstanceStatus
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
Date automaticRestartTime
The time when a stopped DB instance is restarted automatically.
String masterUsername
The master username for the DB instance.
String dBName
Contains the initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
Endpoint endpoint
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating
.
Integer allocatedStorage
The amount of storage in gibibytes (GiB) allocated for the DB instance.
Date instanceCreateTime
The date and time when the DB instance was created.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
Integer backupRetentionPeriod
The number of days for which automatic DB snapshots are retained.
SdkInternalList<T> dBSecurityGroups
A list of DB security group elements containing DBSecurityGroup.Name
and
DBSecurityGroup.Status
subelements.
SdkInternalList<T> vpcSecurityGroups
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
SdkInternalList<T> dBParameterGroups
The list of DB parameter groups applied to this DB instance.
String availabilityZone
The name of the Availability Zone where the DB instance is located.
DBSubnetGroup dBSubnetGroup
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues pendingModifiedValues
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
Date latestRestorableTime
The latest time to which a database in this DB instance can be restored with point-in-time restore.
Boolean multiAZ
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
String engineVersion
The version of the database engine.
Boolean autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
String readReplicaSourceDBInstanceIdentifier
The identifier of the source DB instance if this DB instance is a read replica.
SdkInternalList<T> readReplicaDBInstanceIdentifiers
The identifiers of the read replicas associated with this DB instance.
SdkInternalList<T> readReplicaDBClusterIdentifiers
The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
String replicaMode
The open mode of an Oracle read replica. The default is open-read-only
. For more information, see Working with Oracle Read
Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
String licenseModel
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Integer iops
The Provisioned IOPS (I/O operations per second) value for the DB instance.
SdkInternalList<T> optionGroupMemberships
The list of option group memberships for this DB instance.
String characterSetName
If present, specifies the name of the character set that this instance is associated with.
String ncharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
String secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Boolean publiclyAccessible
Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
SdkInternalList<T> statusInfos
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
String storageType
The storage type associated with the DB instance.
String tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
Integer dbInstancePort
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.
String dBClusterIdentifier
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
Boolean storageEncrypted
Indicates whether the DB instance is encrypted.
String kmsKeyId
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String dbiResourceId
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
SdkInternalList<T> domainMemberships
The Active Directory Domain membership records associated with the DB instance.
Boolean copyTagsToSnapshot
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster.
Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
DBCluster
.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
String enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
Integer promotionTier
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
String dBInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
String timezone
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.
Boolean iAMDatabaseAuthenticationEnabled
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
Boolean performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB instance.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
SdkInternalList<T> enabledCloudwatchLogsExports
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean deletionProtection
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
SdkInternalList<T> associatedRoles
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
Endpoint listenerEndpoint
The listener connection endpoint for SQL Server Always On.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
SdkInternalList<T> tagList
SdkInternalList<T> dBInstanceAutomatedBackupsReplications
The list of replicated automated backups associated with the DB instance.
Boolean customerOwnedIpEnabled
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
String activityStreamStatus
The status of the database activity stream.
String activityStreamKmsKeyId
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String activityStreamKinesisStreamName
The name of the Amazon Kinesis data stream used for the database activity stream.
String activityStreamMode
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
Boolean activityStreamEngineNativeAuditFieldsIncluded
Indicates whether engine-native audit fields are included in the database activity stream.
String automationMode
The automation mode of the RDS Custom DB instance: full
or all paused
. If
full
, the DB instance automates monitoring and instance recovery. If all paused
, the
instance pauses automation for the duration set by --resume-full-automation-mode-minutes
.
Date resumeFullAutomationModeTime
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
String customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
String backupTarget
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
String networkType
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
String activityStreamPolicyStatus
The status of the policy state of the activity stream.
Integer storageThroughput
The storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
String dBSystemId
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
MasterUserSecret masterUserSecret
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
CertificateDetails certificateDetails
The details of the DB instance's server certificate.
String readReplicaSourceDBClusterIdentifier
The identifier of the source DB cluster if this DB instance is a read replica.
String percentProgress
The progress of the storage optimization operation as a percentage.
String dBInstanceArn
The Amazon Resource Name (ARN) for the automated backups.
String dbiResourceId
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
String region
The Amazon Web Services Region associated with the automated backup.
String dBInstanceIdentifier
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow restoreWindow
Earliest and latest time an instance can be restored to.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Provides a list of status information for an automated backup:
active
- Automated backups for current instances.
retained
- Automated backups for deleted instances.
creating
- Automated backups that are waiting for the first automated snapshot to be available.
Integer port
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
String availabilityZone
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
String vpcId
Provides the VPC ID associated with the DB instance.
Date instanceCreateTime
Provides the date and time that the DB instance was created.
String masterUsername
The master user name of an automated backup.
String engine
The name of the database engine for this automated backup.
String engineVersion
The version of the database engine for the automated backup.
String licenseModel
License model information for the automated backup.
Integer iops
The IOPS (I/O operations per second) value for the automated backup.
String optionGroupName
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
String tdeCredentialArn
The ARN from the key store with which the automated backup is associated for TDE encryption.
Boolean encrypted
Specifies whether the automated backup is encrypted.
String storageType
Specifies the storage type associated with the automated backup.
String kmsKeyId
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String timezone
The time zone of the automated backup. In most cases, the Timezone
element is empty.
Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time
zone specified.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Integer backupRetentionPeriod
The retention period for the automated backups.
String dBInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) for the replicated automated backups.
SdkInternalList<T> dBInstanceAutomatedBackupsReplications
The list of replications to different Amazon Web Services Regions associated with the automated backup.
String backupTarget
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Integer storageThroughput
Specifies the storage throughput for the automated backup.
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
String dBInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) of the replicated automated backups.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
String featureName
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For
information about supported feature names, see DBEngineVersion
.
String status
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE
- the IAM role ARN is associated with the DB instance and can be used to access other Amazon
Web Services services on your behalf.
PENDING
- the IAM role ARN is being associated with the DB instance.
INVALID
- the IAM role ARN is associated with the DB instance, but the DB instance is unable to
assume the IAM role in order to access other Amazon Web Services services on your behalf.
String statusType
This value is currently "read replication."
Boolean normal
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
String status
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.
String message
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
String dBParameterGroupName
The name of the DB parameter group.
String dBParameterGroupFamily
The name of the DB parameter group family that this DB parameter group is compatible with.
String description
Provides the customer-specified description for this DB parameter group.
String dBParameterGroupArn
The Amazon Resource Name (ARN) for the DB parameter group.
String dBProxyName
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
String dBProxyArn
The Amazon Resource Name (ARN) for the proxy.
String status
The current status of this proxy. A status of available
means the proxy is ready to handle requests.
Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
String engineFamily
The kinds of databases that the proxy can connect to. This value determines which database network protocol the
proxy recognizes when it interprets network traffic to and from the database. MYSQL
supports Aurora
MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL
supports Aurora PostgreSQL and RDS
for PostgreSQL databases. SQLSERVER
supports RDS for Microsoft SQL Server databases.
String vpcId
Provides the VPC ID of the DB proxy.
SdkInternalList<T> vpcSecurityGroupIds
Provides a list of VPC security groups that the proxy belongs to.
SdkInternalList<T> vpcSubnetIds
The EC2 subnet IDs for the proxy.
SdkInternalList<T> auth
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
String roleArn
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
String endpoint
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
Boolean requireTLS
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
Integer idleClientTimeout
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
Boolean debugLogging
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
Date createdDate
The date and time when the proxy was first created.
Date updatedDate
The date and time when the proxy was last updated.
String dBProxyEndpointName
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
String dBProxyEndpointArn
The Amazon Resource Name (ARN) for the DB proxy endpoint.
String dBProxyName
The identifier for the DB proxy that is associated with this DB proxy endpoint.
String status
The current status of this DB proxy endpoint. A status of available
means the endpoint is ready to
handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to
resolve an issue.
String vpcId
Provides the VPC ID of the DB proxy endpoint.
SdkInternalList<T> vpcSecurityGroupIds
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
SdkInternalList<T> vpcSubnetIds
The EC2 subnet IDs for the DB proxy endpoint.
String endpoint
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
Date createdDate
The date and time when the DB proxy endpoint was first created.
String targetRole
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
Boolean isDefault
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
String targetArn
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
String endpoint
The writer endpoint for the RDS DB instance or Aurora DB cluster.
String trackedClusterId
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
String rdsResourceId
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Integer port
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
String type
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
String role
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth targetHealth
Information about the connection health of the RDS Proxy target.
String dBProxyName
The identifier for the RDS proxy associated with this target group.
String targetGroupName
The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
String targetGroupArn
The Amazon Resource Name (ARN) representing the target group.
Boolean isDefault
Whether this target group is the first one used for connection requests by the associated proxy. Because each
proxy is currently associated with a single target group, currently this setting is always true
.
String status
The current status of this target group. A status of available
means the target group is correctly
associated with a database. Other values indicate that you must wait for the target group to be ready, or take
some action to resolve an issue.
ConnectionPoolConfigurationInfo connectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
Date createdDate
The date and time when the target group was first created.
Date updatedDate
The date and time when the target group was last updated.
String ownerId
Provides the Amazon Web Services ID of the owner of a specific DB security group.
String dBSecurityGroupName
Specifies the name of the DB security group.
String dBSecurityGroupDescription
Provides the description of the DB security group.
String vpcId
Provides the VpcId of the DB security group.
SdkInternalList<T> eC2SecurityGroups
Contains a list of EC2SecurityGroup
elements.
SdkInternalList<T> iPRanges
Contains a list of IPRange
elements.
String dBSecurityGroupArn
The Amazon Resource Name (ARN) for the DB security group.
String dBSnapshotIdentifier
Specifies the identifier for the DB snapshot.
String dBInstanceIdentifier
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
Date snapshotCreateTime
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
String engine
Specifies the name of the database engine.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Specifies the status of this DB snapshot.
Integer port
Specifies the port that the database engine was listening on at the time of the snapshot.
String availabilityZone
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
String vpcId
Provides the VPC ID associated with the DB snapshot.
Date instanceCreateTime
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
String masterUsername
Provides the master username for the DB snapshot.
String engineVersion
Specifies the version of the database engine.
String licenseModel
License model information for the restored DB instance.
String snapshotType
Provides the type of the DB snapshot.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
String optionGroupName
Provides the option group name for the DB snapshot.
Integer percentProgress
The percentage of the estimated data that has been transferred.
String sourceRegion
The Amazon Web Services Region that the DB snapshot was created in or copied from.
String sourceDBSnapshotIdentifier
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
String storageType
Specifies the storage type associated with DB snapshot.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
Boolean encrypted
Specifies whether the DB snapshot is encrypted.
String kmsKeyId
If Encrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String dBSnapshotArn
The Amazon Resource Name (ARN) for the DB snapshot.
String timezone
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.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
SdkInternalList<T> processorFeatures
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.
String dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
SdkInternalList<T> tagList
Date originalSnapshotCreateTime
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
Date snapshotDatabaseTime
The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
String snapshotTarget
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Integer storageThroughput
Specifies the storage throughput for the DB snapshot.
String dBSystemId
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
String attributeName
The name of the manual DB snapshot attribute.
The attribute named restore
refers to the list of Amazon Web Services accounts that have permission
to copy or restore the manual DB cluster snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.
SdkInternalList<T> attributeValues
The value or values for the manual DB snapshot attribute.
If the AttributeName
field is set to restore
, then this element returns a list of IDs
of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of
all
is in the list, then the manual DB snapshot is public and available for any Amazon Web Services
account to copy or restore.
String dBSnapshotIdentifier
The identifier of the manual DB snapshot that the attributes apply to.
SdkInternalList<T> dBSnapshotAttributes
The list of attributes and values for the manual DB snapshot.
String dBSubnetGroupName
The name of the DB subnet group.
String dBSubnetGroupDescription
Provides the description of the DB subnet group.
String vpcId
Provides the VpcId of the DB subnet group.
String subnetGroupStatus
Provides the status of the DB subnet group.
SdkInternalList<T> subnets
Contains a list of Subnet
elements.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
SdkInternalList<T> supportedNetworkTypes
The network type of the DB subnet group.
Valid values:
IPV4
DUAL
A DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
String blueGreenDeploymentIdentifier
The unique identifier of the blue/green deployment to delete. This parameter isn't case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
Boolean deleteTarget
Specifies whether to delete the resources in the green environment. You can't specify this option if the
blue/green deployment status is
SWITCHOVER_COMPLETED
.
BlueGreenDeployment blueGreenDeployment
String engine
The database engine. The only supported engines are custom-oracle-ee
and
custom-oracle-ee-cdb
.
String engineVersion
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for
Amazon RDS. The combination of Engine
and EngineVersion
is unique per customer per
Amazon Web Services Region.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API isn't specified.
CustomDBEngineVersionAMI image
The EC2 image
String dBEngineMediaType
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName
parameter of the
CreateDBInstance
operation.
SdkInternalList<T> supportedNcharCharacterSets
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
parameter of the CreateDBInstance
operation.
SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone
parameter of the
CreateDBInstance
action.
SdkInternalList<T> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports read replicas.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
SdkInternalList<T> supportedFeatureNames
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames
in the output.
String status
The status of the DB engine version, either available
or deprecated
.
Boolean supportsParallelQuery
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
String majorEngineVersion
The major engine version of the CEV.
String databaseInstallationFilesS3BucketName
The name of the Amazon S3 bucket that contains your database installation files.
String databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
String dBEngineVersionArn
The ARN of the custom engine version.
String kMSKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
Date createTime
The creation time of the DB engine version.
SdkInternalList<T> tagList
Boolean supportsBabelfish
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
String customDBEngineVersionManifest
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
Boolean supportsCertificateRotationWithoutRestart
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SdkInternalList<T> supportedCACertificateIdentifiers
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Boolean supportsLocalWriteForwarding
A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String dbClusterResourceId
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
String dBClusterEndpointIdentifier
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating
, available
, deleting
,
inactive
, modifying
. The inactive
state applies to an endpoint that can't
be used for a certain kind of cluster, such as a writer
endpoint for a read-only secondary cluster
in a global database.
String endpointType
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
String customEndpointType
The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
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.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Can't be associated with any DB clusters.
String dBClusterIdentifier
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
Boolean skipFinalSnapshot
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
You must specify a FinalDBSnapshotIdentifier
parameter if SkipFinalSnapshot
is
disabled.
String finalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot
is
disabled.
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
Boolean deleteAutomatedBackups
A value that indicates whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available
state.
String dbiResourceId
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
String dBInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) of the automated backups to delete, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
String dBInstanceIdentifier
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.
Boolean skipFinalSnapshot
A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
parameter.
When a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, RDS can delete the instance only if you
enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
String finalDBSnapshotIdentifier
The DBSnapshotIdentifier
of the new DBSnapshot
created when the
SkipFinalSnapshot
parameter is disabled.
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.
Boolean deleteAutomatedBackups
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.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Can't be associated with any DB instances
String dBProxyEndpointName
The name of the DB proxy endpoint to delete.
DBProxyEndpoint dBProxyEndpoint
The data structure representing the details of the DB proxy endpoint that you delete.
String dBProxyName
The name of the DB proxy to delete.
DBProxy dBProxy
The data structure representing the details of the DB proxy that you delete.
String dBSecurityGroupName
The name of the DB security group to delete.
You can't delete the default DB security group.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Must not be "Default"
String dBSnapshotIdentifier
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available
state.
String dBSubnetGroupName
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
String subscriptionName
The name of the RDS event notification subscription you want to delete.
String globalClusterIdentifier
The cluster identifier of the global database cluster being deleted.
String optionGroupName
The name of the option group to be deleted.
You can't delete default option groups.
String dBProxyName
The identifier of the DBProxy
that is associated with the DBProxyTargetGroup
.
String targetGroupName
The identifier of the DBProxyTargetGroup
.
SdkInternalList<T> dBInstanceIdentifiers
One or more DB instance identifiers.
SdkInternalList<T> dBClusterIdentifiers
One or more DB cluster identifiers.
SdkInternalList<T> accountQuotas
A list of AccountQuota
objects. Within this list, each quota has a name, a count of usage toward the
quota maximum, and a maximum value for the quota.
String blueGreenDeploymentIdentifier
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.
Constraints:
Must match an existing blue/green deployment identifier.
SdkInternalList<T> filters
A filter that specifies one or more blue/green deployments to describe.
Valid Values:
blue-green-deployment-identifier
- Accepts system-generated identifiers for blue/green deployments.
The results list only includes information about the blue/green deployments with the specified identifiers.
blue-green-deployment-name
- Accepts user-supplied names for blue/green deployments. The results
list only includes information about the blue/green deployments with the specified names.
source
- Accepts source databases for a blue/green deployment. The results list only includes
information about the blue/green deployments with the specified source databases.
target
- Accepts target databases for a blue/green deployment. The results list only includes
information about the blue/green deployments with the specified target databases.
String marker
An optional pagination token provided by a previous DescribeBlueGreenDeployments
request. If you
specify this parameter, the response only includes records beyond the marker, up to the value specified by
MaxRecords
.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints:
Must be a minimum of 20.
Can't exceed 100.
SdkInternalList<T> blueGreenDeployments
A list of blue/green deployments in the current account and Amazon Web Services Region.
String marker
A pagination token that can be used in a later DescribeBlueGreenDeployments
request.
String certificateIdentifier
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.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
SdkInternalList<T> certificates
The list of Certificate
objects for the Amazon Web Services account.
String marker
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
.
String dbClusterResourceId
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
String dBClusterIdentifier
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.
SdkInternalList<T> filters
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
retained
- Automated backups for deleted clusters and after backup replication is stopped.
db-cluster-id
- Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list
includes only information about the DB cluster automated backups identified by these ARNs.
db-cluster-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The
results list includes only information about the DB cluster resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only
records beyond the marker, up to MaxRecords
.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only
records beyond the marker, up to MaxRecords
.
SdkInternalList<T> dBClusterAutomatedBackups
A list of DBClusterAutomatedBackup
backups.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String backtrackIdentifier
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier.
Example: 123e4567-e89b-12d3-a456-426655440000
SdkInternalList<T> filters
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.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
A pagination token that can be used in a later DescribeDBClusterBacktracks
request.
SdkInternalList<T> dBClusterBacktracks
Contains a list of backtracks for the user.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointIdentifier
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
SdkInternalList<T> filters
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
name-value pairs, in the format
Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...
. Name
can be one of: db-cluster-endpoint-type
, db-cluster-endpoint-custom-type
,
db-cluster-endpoint-id
, db-cluster-endpoint-status
. Values
for the
db-cluster-endpoint-type
filter can be one or more of: reader
, writer
,
custom
. Values
for the db-cluster-endpoint-custom-type
filter can be one
or more of: reader
, any
. Values
for the
db-cluster-endpoint-status
filter can be one or more of: available
,
creating
, deleting
, inactive
, modifying
.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBClusterEndpoints
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBClusterParameterGroups
A list of DB cluster parameter groups.
String dBClusterParameterGroupName
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.
String source
A value that indicates to return only parameters for a specific source. Parameter sources can be
engine
, service
, or customer
.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
SdkInternalList<T> parameters
Provides a list of parameters for the DB cluster parameter group.
String marker
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
.
String dBClusterSnapshotIdentifier
The identifier for the DB cluster snapshot to describe the attributes for.
String dBClusterIdentifier
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in
conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
String dBClusterSnapshotIdentifier
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.
String snapshotType
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my
Amazon Web Services account.
manual
- Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services
account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are
returned. You can include shared DB cluster snapshots with these results by enabling the
IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling
the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
SdkInternalList<T> filters
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
Boolean includeShared
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another
Amazon Web Services account by the ModifyDBClusterSnapshotAttribute
API action.
Boolean includePublic
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
String dbClusterResourceId
A specific DB cluster resource ID to describe.
String marker
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
.
SdkInternalList<T> dBClusterSnapshots
Provides a list of DB cluster snapshots for the user.
String dBClusterIdentifier
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DB cluster identifier.
SdkInternalList<T> filters
A filter that specifies one or more DB clusters to describe.
Supported Filters:
clone-group-id
- Accepts clone group identifiers. The results list only includes information about
the DB clusters associated with these clone groups.
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id
- Accepts DB cluster resource identifiers. The results list will only include
information about the DB clusters identified by these DB cluster resource identifiers.
domain
- Accepts Active Directory directory IDs. The results list only includes information about
the DB clusters associated with these domains.
engine
- Accepts engine names. The results list only includes information about the DB clusters for
these engines.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
Boolean includeShared
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
String marker
A pagination token that can be used in a later DescribeDBClusters
request.
SdkInternalList<T> dBClusters
Contains a list of DB clusters for the user.
String engine
The database engine to return.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String engineVersion
The database engine version to return.
Example: 5.1.49
String dBParameterGroupFamily
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
SdkInternalList<T> filters
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes
information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB
engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about the DB
engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about the DB
engine versions for these statuses. Valid statuses are the following:
available
deprecated
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords
value is
available, a pagination token called a marker is included in the response so you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
Boolean defaultOnly
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
Boolean listSupportedCharacterSets
A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for
CreateDBInstance
, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you set
ListSupportedCharacterSets
to true
, RDS Custom returns no results.
Boolean listSupportedTimezones
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones
to true
, RDS Custom returns no results.
Boolean includeAll
A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
String marker
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
.
SdkInternalList<T> dBEngineVersions
A list of DBEngineVersion
elements.
String dbiResourceId
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
String dBInstanceIdentifier
(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's automated backup. This parameter isn't case-sensitive.
SdkInternalList<T> filters
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active
- Automated backups for current instances.
creating
- Automated backups that are waiting for the first automated snapshot to be available.
retained
- Automated backups for deleted instances and after backup replication is stopped.
db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
includes only information about the DB instance automated backups identified by these ARNs.
dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only
records beyond the marker, up to MaxRecords
.
String dBInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) of the replicated automated backups, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
String marker
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
.
SdkInternalList<T> dBInstanceAutomatedBackups
A list of DBInstanceAutomatedBackup
instances.
String dBInstanceIdentifier
The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
SdkInternalList<T> filters
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 only includes 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 only includes information about the DB instances identified by these ARNs.
dbi-resource-id
- Accepts DB instance resource identifiers. The results list only includes
information about the DB instances identified by these DB instance resource identifiers.
domain
- Accepts Active Directory directory IDs. The results list only includes information about
the DB instances associated with these domains.
engine
- Accepts engine names. The results list only includes information about the DB instances for
these engines.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBInstances
A list of DBInstance
instances.
String dBInstanceIdentifier
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.
String filenameContains
Filters the available log files for log file names that contain the specified string.
Long fileLastWritten
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
Long fileSize
Filters the available log files for files larger than the specified size.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
String marker
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
SdkInternalList<T> describeDBLogFiles
The DB log files returned.
String marker
A pagination token that can be used in a later DescribeDBLogFiles
request.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBParameterGroups
A list of DBParameterGroup
instances.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
String source
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
SdkInternalList<T> parameters
A list of Parameter
values.
String marker
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
.
String dBProxyName
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
SdkInternalList<T> filters
This parameter is not currently supported.
String marker
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
.
Integer maxRecords
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.
SdkInternalList<T> dBProxies
A return value representing an arbitrary number of DBProxy
data structures.
String marker
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
.
String dBProxyName
The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
String dBProxyEndpointName
The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
SdkInternalList<T> filters
This parameter is not currently supported.
String marker
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
.
Integer maxRecords
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.
SdkInternalList<T> dBProxyEndpoints
The list of ProxyEndpoint
objects returned by the API operation.
String marker
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
.
String dBProxyName
The identifier of the DBProxy
associated with the target group.
String targetGroupName
The identifier of the DBProxyTargetGroup
to describe.
SdkInternalList<T> filters
This parameter is not currently supported.
String marker
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
.
Integer maxRecords
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.
SdkInternalList<T> targetGroups
An arbitrary number of DBProxyTargetGroup
objects, containing details of the corresponding target
groups.
String marker
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
.
String dBProxyName
The identifier of the DBProxyTarget
to describe.
String targetGroupName
The identifier of the DBProxyTargetGroup
to describe.
SdkInternalList<T> filters
This parameter is not currently supported.
String marker
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
.
Integer maxRecords
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.
SdkInternalList<T> targets
An arbitrary number of DBProxyTarget
objects, containing details of the corresponding targets.
String marker
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
.
String dBSecurityGroupName
The name of the DB security group to return details for.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBSecurityGroups
A list of DBSecurityGroup
instances.
String dBSnapshotIdentifier
The identifier for the DB snapshot to describe the attributes for.
String dBInstanceIdentifier
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
String dBSnapshotIdentifier
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
String snapshotType
The type of snapshots to be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon
Web Services account.
manual
- Return all DB snapshots that have been taken by my Amazon Web Services account.
shared
- Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public
- Return all DB snapshots that have been marked as public.
awsbackup
- Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup
type does not apply to Aurora.
If you don't specify a SnapshotType
value, then both automated and manual snapshots are returned.
Shared and public DB snapshots are not included in the returned results by default. You can include shared
snapshots with these results by enabling the IncludeShared
parameter. You can include public
snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The
IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
SdkInternalList<T> filters
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id
- Accepts DB snapshot identifiers.
dbi-resource-id
- Accepts identifiers of source DB instances.
snapshot-type
- Accepts types of DB snapshots.
engine
- Accepts names of database engines.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
Boolean includeShared
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web
Services account by using the ModifyDBSnapshotAttribute
API action.
This setting doesn't apply to RDS Custom.
Boolean includePublic
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
String dbiResourceId
A specific DB resource ID to describe.
String marker
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
.
SdkInternalList<T> dBSnapshots
A list of DBSnapshot
instances.
String dBSubnetGroupName
The name of the DB subnet group to return details for.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> dBSubnetGroups
A list of DBSubnetGroup
instances.
String dBParameterGroupFamily
The name of the DB cluster parameter group family to return engine parameter information for.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String dBParameterGroupFamily
The name of the DB parameter group family.
Valid Values:
aurora-mysql5.7
aurora-mysql8.0
aurora-postgresql10
aurora-postgresql11
aurora-postgresql12
aurora-postgresql13
aurora-postgresql14
custom-oracle-ee-19
mariadb10.2
mariadb10.3
mariadb10.4
mariadb10.5
mariadb10.6
mysql5.7
mysql8.0
oracle-ee-19
oracle-ee-cdb-19
oracle-ee-cdb-21
oracle-se2-19
oracle-se2-cdb-19
oracle-se2-cdb-21
postgres10
postgres11
postgres12
postgres13
postgres14
sqlserver-ee-11.0
sqlserver-ee-12.0
sqlserver-ee-13.0
sqlserver-ee-14.0
sqlserver-ee-15.0
sqlserver-ex-11.0
sqlserver-ex-12.0
sqlserver-ex-13.0
sqlserver-ex-14.0
sqlserver-ex-15.0
sqlserver-se-11.0
sqlserver-se-12.0
sqlserver-se-13.0
sqlserver-se-14.0
sqlserver-se-15.0
sqlserver-web-11.0
sqlserver-web-12.0
sqlserver-web-13.0
sqlserver-web-14.0
sqlserver-web-15.0
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String sourceType
The type of source that is generating the events. For RDS Proxy events, specify db-proxy
.
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
|
db-proxy
SdkInternalList<T> filters
This parameter isn't currently supported.
SdkInternalList<T> eventCategoriesMapList
A list of EventCategoriesMap
data types.
String sourceIdentifier
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier
is supplied, SourceType
must also be provided.
If the source type is a DB instance, a DBInstanceIdentifier
value must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier
value must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier
value must be supplied.
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
value must be supplied.
If the source type is an RDS Proxy, a DBProxyName
value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
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
Date endTime
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
Integer duration
The number of minutes to retrieve events for.
Default: 60
SdkInternalList<T> eventCategories
A list of event categories that trigger notifications for a event notification subscription.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
An optional pagination token provided by a previous Events request. If this parameter is specified, the response
includes only records beyond the marker, up to the value specified by MaxRecords
.
SdkInternalList<T> events
A list of Event
instances.
String subscriptionName
The name of the RDS event notification subscription you want to describe.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> eventSubscriptionsList
A list of EventSubscriptions data types.
String exportTaskIdentifier
The identifier of the snapshot or cluster export task to be described.
String sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
SdkInternalList<T> filters
Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier
- An identifier for the snapshot or cluster export task.
s3-bucket
- The Amazon S3 bucket the data is exported to.
source-arn
- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
status
- The status of the export task. Must be lowercase. Valid statuses are the following:
canceled
canceling
complete
failed
in_progress
starting
String marker
An optional pagination token provided by a previous DescribeExportTasks
request. If you specify this
parameter, the response includes only records beyond the marker, up to the value specified by the
MaxRecords
parameter.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified value, a
pagination token called a marker is included in the response. You can use the marker in a later
DescribeExportTasks
request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String sourceType
The type of source for the export.
String marker
A pagination token that can be used in a later DescribeExportTasks
request. A marker is used for
pagination to identify the location to begin output for the next response of DescribeExportTasks
.
SdkInternalList<T> exportTasks
Information about an export of a snapshot or cluster to Amazon S3.
String globalClusterIdentifier
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.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> globalClusters
The list of global clusters returned by this request.
String engineName
A required parameter. Options available for the given engine name are described.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String majorEngineVersion
If specified, filters the results to include only options for the specified major engine version.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
SdkInternalList<T> optionGroupOptions
String marker
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
.
String optionGroupName
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
SdkInternalList<T> filters
This parameter isn't currently supported.
String marker
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
.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String engineName
Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String majorEngineVersion
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.
SdkInternalList<T> optionGroupsList
List of option groups.
String marker
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
.
String engine
The name of the engine to retrieve DB instance options for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
String engineVersion
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
String licenseModel
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
String availabilityZoneGroup
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
Boolean vpc
A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 10000.
String marker
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
.
SdkInternalList<T> orderableDBInstanceOptions
An OrderableDBInstanceOption
structure containing information about orderable options for the DB
instance.
String marker
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
.
String resourceIdentifier
The ARN of a resource to return pending maintenance actions for.
SdkInternalList<T> filters
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 only includes 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 only
includes pending maintenance actions for the DB instances identified by these ARNs.
String marker
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
.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can
retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
SdkInternalList<T> pendingMaintenanceActions
A list of the pending maintenance actions for the resource.
String marker
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
.
String reservedDBInstancesOfferingId
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
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
String duration
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
String productDescription
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
String offeringType
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"
Boolean multiAZ
A value that indicates whether to show only those reservations that support Multi-AZ.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords
value is
available, a pagination token called a marker is included in the response so you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> reservedDBInstancesOfferings
A list of reserved DB instance offerings.
String reservedDBInstanceId
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
String reservedDBInstancesOfferingId
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
String duration
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
String productDescription
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
String offeringType
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"
Boolean multiAZ
A value that indicates whether to show only those reservations that support Multi-AZ.
String leaseId
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
SdkInternalList<T> filters
This parameter isn't currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords
value is
available, a pagination token called a marker is included in the response so you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
String marker
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
.
SdkInternalList<T> reservedDBInstances
A list of reserved DB instances.
String regionName
The source Amazon Web Services Region name. For example, us-east-1
.
Constraints:
Must specify a valid Amazon Web Services Region name.
Integer maxRecords
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve
the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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
.
SdkInternalList<T> filters
This parameter isn't currently supported.
String marker
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
.
SdkInternalList<T> sourceRegions
A list of SourceRegion
instances that contains each source Amazon Web Services Region that the
current Amazon Web Services Region can get a read replica or a DB snapshot from.
String dBInstanceIdentifier
The customer identifier or the ARN of your DB instance.
String domain
The identifier of the Active Directory Domain.
String status
The status of the Active Directory Domain membership for the DB instance or cluster. Values include
joined
, pending-join
, failed
, and so on.
String fQDN
The fully qualified domain name (FQDN) of the Active Directory Domain.
String iAMRoleName
The name of the IAM role used when making API calls to the Directory Service.
String oU
The Active Directory organizational unit for the DB instance or cluster.
String authSecretArn
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
SdkInternalList<T> dnsIps
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
String dBInstanceIdentifier
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.
String logFileName
The name of the log file to be downloaded.
String marker
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.
Integer numberOfLines
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.
If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
String status
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
String eC2SecurityGroupName
Specifies the name of the EC2 security group.
String eC2SecurityGroupId
Specifies the id of the EC2 security group.
String eC2SecurityGroupOwnerId
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the
EC2SecurityGroupName
field.
String dBParameterGroupFamily
Specifies the name of the DB parameter group family that the engine default parameters apply to.
String marker
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
.
SdkInternalList<T> parameters
Contains a list of engine default parameters.
String sourceIdentifier
Provides the identifier for the source of the event.
String sourceType
Specifies the source type for this event.
String message
Provides the text of this event.
SdkInternalList<T> eventCategories
Specifies the category for the event.
Date date
Specifies the date and time of the event.
String sourceArn
The Amazon Resource Name (ARN) for the event.
String sourceType
The source type that the returned categories belong to
SdkInternalList<T> eventCategories
The event categories for the specified source type
String customerAwsId
The Amazon Web Services customer account associated with the RDS event notification subscription.
String custSubscriptionId
The RDS event notification subscription Id.
String snsTopicArn
The topic ARN of the RDS event notification subscription.
String status
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
The time the RDS event notification subscription was created.
String sourceType
The source type for the RDS event notification subscription.
SdkInternalList<T> sourceIdsList
A list of source IDs for the RDS event notification subscription.
SdkInternalList<T> eventCategoriesList
A list of event categories for the RDS event notification subscription.
Boolean enabled
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
String eventSubscriptionArn
The Amazon Resource Name (ARN) for the event subscription.
String exportTaskIdentifier
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
String sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
SdkInternalList<T> exportOnly
The data exported from the snapshot or cluster. Valid values are the following:
database
- Export all the data from a specified database.
database.table
table-name - Export a table of the snapshot or cluster. This format is valid
only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema
schema-name - Export a database schema of the snapshot or cluster. This
format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table
table-name - Export a table of the database schema. This format is
valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Date snapshotTime
The time that the snapshot was created.
Date taskStartTime
The time that the snapshot or cluster export task started.
Date taskEndTime
The time that the snapshot or cluster export task ended.
String s3Bucket
The Amazon S3 bucket that the snapshot or cluster is exported to.
String s3Prefix
The Amazon S3 bucket prefix that is the file name and path of the exported data.
String iamRoleArn
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
String kmsKeyId
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
String status
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
Integer percentProgress
The progress of the snapshot or cluster export task as a percentage.
Integer totalExtractedDataInGB
The total amount of data exported, in gigabytes.
String failureCause
The reason the export failed, if it failed.
String warningMessage
A warning about the snapshot or cluster export task.
String sourceType
The type of source for the export.
String dBClusterIdentifier
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
String targetDBInstanceIdentifier
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for
example mydbcluster-replica1
.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
String globalClusterIdentifier
The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database.
Constraints:
Must match the identifier of an existing global database cluster.
String targetDbClusterIdentifier
The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
Boolean allowDataLoss
Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss
, the global database cluster operation defaults to a switchover.
Constraints:
Can't be specified together with the Switchover
parameter.
Boolean switchover
Specifies whether to switch over this global database cluster.
Constraints:
Can't be specified together with the AllowDataLoss
parameter.
String status
The current status of the global cluster. Possible values are as follows:
pending The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over This status covers the range of Aurora internal operations that take place during the switchover or failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.
cancelling The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
String fromDbClusterArn
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
String toDbClusterArn
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Boolean isDataLossAllowed
Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
String name
The name of the filter. Filter names are case-sensitive.
SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
String globalClusterIdentifier
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
String globalClusterResourceId
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
String globalClusterArn
The Amazon Resource Name (ARN) for the global database cluster.
String status
Specifies the current state of this global database cluster.
String engine
The Aurora database engine used by the global database cluster.
String engineVersion
Indicates the database engine version.
String databaseName
The default database name within the new global database cluster.
Boolean storageEncrypted
The storage encryption setting for the global database cluster.
Boolean deletionProtection
The deletion protection setting for the new global database cluster.
SdkInternalList<T> globalClusterMembers
The list of primary and secondary clusters within the global database cluster.
FailoverState failoverState
A data object containing all properties for the current state of an in-process or pending switchover or failover
process for this global cluster (Aurora global database). This object is empty unless the
SwitchoverGlobalCluster
or FailoverGlobalCluster
operation was called on this global
cluster.
String dBClusterArn
The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
SdkInternalList<T> readers
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.
Boolean isWriter
Specifies whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.
String globalWriteForwardingStatus
Specifies whether a secondary cluster in the global cluster has write forwarding enabled, not enabled, or is in the process of enabling it.
String synchronizationStatus
The status of synchronization of each Aurora DB cluster in the global cluster.
String resourceName
The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
SdkInternalList<T> filters
This parameter isn't currently supported.
SdkInternalList<T> tagList
List of tags returned by the ListTagsForResource
operation.
String secretArn
The Amazon Resource Name (ARN) of the secret.
String secretStatus
The status of the secret.
The possible status values include the following:
creating
- The secret is being created.
active
- The secret is available for normal use and rotation.
rotating
- The secret is being rotated.
impaired
- The secret can be used to access database credentials, but it can't be rotated. A secret
might have this status if, for example, permissions are changed so that RDS can no longer access either the
secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
String kmsKeyId
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
String resourceArn
The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example,
arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db
.
String auditPolicyState
The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.
String kmsKeyId
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
String kinesisStreamName
The name of the Amazon Kinesis data stream to be used for the database activity stream.
String status
The status of the modification to the database activity stream.
String mode
The mode of the database activity stream.
Boolean engineNativeAuditFieldsIncluded
Indicates whether engine-native audit fields are included in the database activity stream.
String policyStatus
The status of the modification to the policy state of the database activity stream.
String certificateIdentifier
The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates
CLI command or the
DescribeCertificates
API operation.
Boolean removeCustomerOverride
A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster.
Integer capacity
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1
, 2
, 4
, 8
,
16
, 32
, 64
, 128
, and 256
.
For Aurora PostgreSQL, valid capacity values are 2
, 4
, 8
, 16
,
32
, 64
, 192
, and 384
.
Integer secondsBeforeTimeout
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
String timeoutAction
The action to take when the timeout is reached, either ForceApplyCapacityChange
or
RollbackCapacityChange
.
ForceApplyCapacityChange
, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange
ignores the capacity change if a scaling point isn't found in the timeout
period.
String dBClusterIdentifier
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Integer pendingCapacity
A value that specifies the capacity that the DB cluster scales to next.
Integer currentCapacity
The current capacity of the DB cluster.
Integer secondsBeforeTimeout
The number of seconds before a call to ModifyCurrentDBClusterCapacity
times out.
String timeoutAction
The timeout action of a call to ModifyCurrentDBClusterCapacity
, either
ForceApplyCapacityChange
or RollbackCapacityChange
.
String engine
The DB engine. The only supported values are custom-oracle-ee
and custom-oracle-ee-cdb
.
String engineVersion
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but
optional for Amazon RDS. The combination of Engine
and EngineVersion
is unique per
customer per Amazon Web Services Region.
String description
An optional description of your CEV.
String status
The availability status to be assigned to the CEV. Valid values are as follows:
You can use this CEV to create a new RDS Custom DB instance.
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a
CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV
from available
to inactive
, and from inactive
back to
available
. To change the availability status of the CEV, it must not currently be in use by an RDS
Custom instance, snapshot, or automated backup.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API isn't specified.
CustomDBEngineVersionAMI image
The EC2 image
String dBEngineMediaType
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SdkInternalList<T> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName
parameter of the
CreateDBInstance
operation.
SdkInternalList<T> supportedNcharCharacterSets
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName
parameter of the CreateDBInstance
operation.
SdkInternalList<T> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
SdkInternalList<T> supportedTimezones
A list of the time zones supported by this engine for the Timezone
parameter of the
CreateDBInstance
action.
SdkInternalList<T> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports read replicas.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
SdkInternalList<T> supportedFeatureNames
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames
in the output.
String status
The status of the DB engine version, either available
or deprecated
.
Boolean supportsParallelQuery
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
String majorEngineVersion
The major engine version of the CEV.
String databaseInstallationFilesS3BucketName
The name of the Amazon S3 bucket that contains your database installation files.
String databaseInstallationFilesS3Prefix
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
String dBEngineVersionArn
The ARN of the custom engine version.
String kMSKeyId
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
Date createTime
The creation time of the DB engine version.
SdkInternalList<T> tagList
Boolean supportsBabelfish
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
String customDBEngineVersionManifest
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
Boolean supportsCertificateRotationWithoutRestart
A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SdkInternalList<T> supportedCACertificateIdentifiers
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Boolean supportsLocalWriteForwarding
A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String dBClusterEndpointIdentifier
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
String endpointType
The type of the endpoint. One of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
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.
String dBClusterEndpointIdentifier
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
String dBClusterEndpointResourceIdentifier
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
String endpoint
The DNS address of the endpoint.
String status
The current status of the endpoint. One of: creating
, available
, deleting
,
inactive
, modifying
. The inactive
state applies to an endpoint that can't
be used for a certain kind of cluster, such as a writer
endpoint for a read-only secondary cluster
in a global database.
String endpointType
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
String customEndpointType
The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
SdkInternalList<T> staticMembers
List of DB instance identifiers that are part of the custom endpoint group.
SdkInternalList<T> excludedMembers
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.
String dBClusterEndpointArn
The Amazon Resource Name (ARN) for the endpoint.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to modify.
SdkInternalList<T> parameters
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate
value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters.
When the application method is immediate
, changes to dynamic parameters are applied immediately to
the DB clusters associated with the parameter group. When the application method is pending-reboot
,
changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters
associated with the parameter group.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
String newDBClusterIdentifier
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 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
Boolean applyImmediately
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this
parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Integer port
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
String optionGroupName
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
Boolean enableIAMDatabaseAuthentication
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
String engineVersion
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.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean allowMajorVersionUpgrade
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that
is a different major version than the DB cluster's current version.
String dBInstanceParameterGroupName
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB cluster
isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next
maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
String domain
The Active Directory directory ID to move the DB cluster to. Specify none
to remove the cluster from
its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
ScalingConfiguration scalingConfiguration
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
Boolean deletionProtection
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean enableHttpEndpoint
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Boolean copyTagsToSnapshot
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean enableGlobalWriteForwarding
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
String dBClusterInstanceClass
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions, or for
all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer allocatedStorage
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
String storageType
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Boolean autoMinorVersionUpgrade
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To
turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than
0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
String monitoringRoleArn
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
Boolean enablePerformanceInsights
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration
String networkType
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
Boolean manageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Boolean rotateMasterUserPassword
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
String engineMode
The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
Boolean allowEngineModeChange
Specifies whether engine mode changes from serverless
to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter
from the DB cluster's current engine mode.
Boolean enableLocalWriteForwarding
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
String dBClusterSnapshotIdentifier
The identifier for the DB cluster snapshot to modify the attributes for.
String attributeName
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot,
set this value to restore
.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
SdkInternalList<T> valuesToAdd
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName
.
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to
include one or more Amazon Web Services account IDs, or all
to make the manual DB cluster snapshot
restorable by any Amazon Web Services account. Do not add the all
value for any manual DB cluster
snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
SdkInternalList<T> valuesToRemove
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName
.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot,
set this list to include one or more Amazon Web Services account identifiers, or all
to remove
authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify
all
, an Amazon Web Services account whose account ID is explicitly added to the restore
attribute can still copy or restore a manual DB cluster snapshot.
String dBInstanceIdentifier
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
Integer allocatedStorage
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
.
String dBInstanceClass
The new compute and memory capacity of the DB instance, for example db.m4.large
. Not all DB instance
classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide or Aurora DB
instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB
instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
maintenance window, unless you specify ApplyImmediately
in your request.
Default: Uses existing setting
String dBSubnetGroupName
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
window, unless you enable ApplyImmediately
.
This parameter doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
Example: mydbsubnetgroup
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB security groups.
SdkInternalList<T> vpcSecurityGroupIds
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information,
see ModifyDBCluster
.)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
Boolean applyImmediately
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB instance. 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.
String masterUserPassword
The new password for the master user.
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 RDS API operations 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.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see
ModifyDBCluster
.)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@".
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
String dBParameterGroupName
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom DB instances.
Default: Uses existing setting
Constraints:
Must be in the same DB parameter group family as the DB instance.
Integer backupRetentionPeriod
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.
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately
parameter
is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the
change is asynchronously applied as soon as possible.
This setting doesn't apply to Amazon Aurora DB instances. 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't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
parameter. Changing this parameter doesn't result in an outage and the
change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from
an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range 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 causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
The day values must be mon | tue | wed | thu | fri | sat | sun
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
Boolean multiAZ
Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
String engineVersion
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the
change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the
current minor version is lower. For information about valid engine versions, see CreateDBInstance
,
or call DescribeDBEngineVersions
.
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the
PATCH_DB_FAILURE
lifecycle.
Boolean allowMajorVersionUpgrade
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion
parameter
that's a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
String licenseModel
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
Integer iops
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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
String optionGroupName
The option group to associate the DB instance with.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately
parameter is
enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom DB instances.
String newDBInstanceIdentifier
The new 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 ApplyImmediately
. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
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
String storageType
The storage type to associate 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: gp2 | gp3 | io1 | standard
Default: io1
, if the Iops
parameter is specified. Otherwise, gp2
.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom DB instances.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
String cACertificateIdentifier
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
String domain
The Active Directory directory ID to move the DB instance to. Specify none
to remove the instance
from its current domain. You must create the domain before this operation. Currently, you can create only MySQL,
Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
String domainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
String domainOu
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
String domainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
SdkInternalList<T> domainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Boolean copyTagsToSnapshot
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster.
Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see
ModifyDBCluster
.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
disable collection of Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, set MonitoringInterval
to a value other than
0
.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
Integer dBPortNumber
The port number on which the database accepts connections.
The value of the DBPortNumber
parameter must not match any of the port values specified for options
in the option group for the DB instance.
If you change the DBPortNumber
value, your database restarts regardless of the value of the
ApplyImmediately
parameter.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, or 49152-49156
.
Boolean publiclyAccessible
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
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.
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
This setting doesn't apply to RDS Custom DB instances.
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
Boolean disableDomain
Specifies whether to remove the DB instance from the Active Directory domain.
Integer promotionTier
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
Boolean enableIAMDatabaseAuthentication
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
Boolean enablePerformanceInsights
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS returns an error.
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration
parameter is always applied to the DB instance
immediately. Therefore, the ApplyImmediately
parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom DB instances.
Boolean useDefaultProcessorFeatures
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
Boolean deletionProtection
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
Boolean certificateRotationRestart
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
String replicaMode
A value that sets the open mode of a replica database to either mounted or read-only.
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
Boolean enableCustomerOwnedIp
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
String awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
String automationMode
The automation mode of the RDS Custom DB instance. If full
, the DB instance automates monitoring and
instance recovery. If all paused
, the instance pauses automation for the duration set by
ResumeFullAutomationModeMinutes
.
Integer resumeFullAutomationModeMinutes
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
String networkType
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
Integer storageThroughput
The storage throughput value for the DB instance.
This setting applies only to the gp3
storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Boolean manageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, Amazon RDS deletes the secret and uses the new password
for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
Boolean rotateMasterUserPassword
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
String engine
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb
or oracle-se2-cdb
.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are
permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To
avoid reverting to the default, specify a new parameter group with --db-parameter-group-name
and a
new option group with --option-group-name
.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup
.
SdkInternalList<T> parameters
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate
value with dynamic parameters only. You can use the
pending-reboot
value for both dynamic and static parameters.
When the application method is immediate
, changes to dynamic parameters are applied immediately to
the DB instances associated with the parameter group.
When the application method is pending-reboot
, changes to dynamic and static parameters are applied
after a reboot without failover to the DB instances associated with the parameter group.
You can't use pending-reboot
with dynamic parameters on RDS for SQL Server DB instances. Use
immediate
.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
String dBParameterGroupName
The name of the DB parameter group.
String dBProxyEndpointName
The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
String newDBProxyEndpointName
The new identifier for the DBProxyEndpoint
. An identifier must begin with a letter and must contain
only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
SdkInternalList<T> vpcSecurityGroupIds
The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
DBProxyEndpoint dBProxyEndpoint
The DBProxyEndpoint
object representing the new settings for the DB proxy endpoint.
String dBProxyName
The identifier for the DBProxy
to modify.
String newDBProxyName
The new identifier for the DBProxy
. An identifier must begin with a letter and must contain only
ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
SdkInternalList<T> auth
The new authentication settings for the DBProxy
.
Boolean requireTLS
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
Integer idleClientTimeout
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
Boolean debugLogging
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
SdkInternalList<T> securityGroups
The new list of security groups for the DBProxy
.
DBProxy dBProxy
The DBProxy
object representing the new settings for the proxy.
String targetGroupName
The name of the target group to modify.
String dBProxyName
The name of the proxy.
ConnectionPoolConfiguration connectionPoolConfig
The settings that determine the size and behavior of the connection pool for the target group.
String newName
The new name for the modified DBProxyTarget
. An identifier must begin with a letter and must contain
only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyTargetGroup dBProxyTargetGroup
The settings of the modified DBProxyTarget
.
String dBSnapshotIdentifier
The identifier for the DB snapshot to modify the attributes for.
String attributeName
The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this
value to restore
.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
SdkInternalList<T> valuesToAdd
A list of DB snapshot attributes to add to the attribute specified by AttributeName
.
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include
one or more Amazon Web Services account IDs, or all
to make the manual DB snapshot restorable by any
Amazon Web Services account. Do not add the all
value for any manual DB snapshots that contain
private information that you don't want available to all Amazon Web Services accounts.
SdkInternalList<T> valuesToRemove
A list of DB snapshot attributes to remove from the attribute specified by AttributeName
.
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this
list to include one or more Amazon Web Services account identifiers, or all
to remove authorization
for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all
, an
Amazon Web Services account whose account ID is explicitly added to the restore
attribute can still
copy or restore the manual DB snapshot.
String dBSnapshotIdentifier
The identifier of the DB snapshot to modify.
String engineVersion
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46
(supported for 5.1 DB snapshots)
Oracle
19.0.0.0.ru-2022-01.rur-2022-01.r1
(supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1
(supported for 12.1.0.2 DB snapshots)
12.1.0.2.v8
(supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12
(supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11
(supported for 11.2.0.3 DB snapshots)
PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
String optionGroupName
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.
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
SdkInternalList<T> subnetIds
The EC2 subnet IDs for the DB subnet group.
String subscriptionName
The name of the RDS event notification subscription.
String snsTopicArn
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.
String sourceType
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. For RDS Proxy events, specify db-proxy
.
If this value isn't specified, all events are returned.
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
|
db-proxy
SdkInternalList<T> eventCategories
A list of event categories for a source type (SourceType
) that you want to subscribe to. You can see
a list of the categories for a given source type in Events in the Amazon RDS
User Guide or by using the DescribeEventCategories
operation.
Boolean enabled
A value that indicates whether to activate the subscription.
String globalClusterIdentifier
The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster.
String newGlobalClusterIdentifier
The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
Boolean deletionProtection
Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
String engineVersion
The version number of the database engine to which you want to upgrade.
To list all of the available engine versions for aurora-mysql
(for MySQL-based Aurora global
databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql
(for PostgreSQL-based Aurora
global databases), use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
Boolean allowMajorVersionUpgrade
Specifies whether to allow major version upgrades.
Constraints: Must be enabled if you specify a value for the EngineVersion
parameter that's a
different major version than the global cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
String optionGroupName
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
SdkInternalList<T> optionsToInclude
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
SdkInternalList<T> optionsToRemove
Options in this list are removed from the option group.
Boolean applyImmediately
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
String optionName
The name of the option.
String optionDescription
The description of the option.
Boolean persistent
Indicate if this option is persistent.
Boolean permanent
Indicate if this option is permanent.
Integer port
If required, the port configured for this option to use.
String optionVersion
The version of the option.
SdkInternalList<T> optionSettings
The option settings for this option.
SdkInternalList<T> dBSecurityGroupMemberships
If the option requires access to a port, then this DB security group allows access to the port.
SdkInternalList<T> vpcSecurityGroupMemberships
If the option requires access to a port, then this VPC security group allows access to the port.
String optionName
The configuration of options to include in a group.
Integer port
The optional port for the option.
String optionVersion
The version for the option.
SdkInternalList<T> dBSecurityGroupMemberships
A list of DBSecurityGroupMembership name strings used for this option.
SdkInternalList<T> vpcSecurityGroupMemberships
A list of VpcSecurityGroupMembership name strings used for this option.
SdkInternalList<T> optionSettings
The option settings to include in an option group.
String optionGroupName
Specifies the name of the option group.
String optionGroupDescription
Provides a description of the option group.
String engineName
Indicates the name of the engine that this option group can be applied to.
String majorEngineVersion
Indicates the major engine version associated with this option group.
SdkInternalList<T> options
Indicates what options are available in the option group.
Boolean allowsVpcAndNonVpcInstanceMemberships
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.
String vpcId
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.
String optionGroupArn
Specifies the Amazon Resource Name (ARN) for the option group.
String sourceOptionGroup
Specifies the name of the option group from which this option group is copied.
String sourceAccountId
Specifies the Amazon Web Services account ID for the option group from which this option group is copied.
Date copyTimestamp
Indicates when the option group was copied.
String optionGroupName
The name of the option group that the instance belongs to.
String status
The status of the DB instance's option group membership. Valid values are: in-sync
,
pending-apply
, pending-removal
, pending-maintenance-apply
,
pending-maintenance-removal
, applying
, removing
, and failed
.
String name
The name of the option.
String description
The description of the option.
String engineName
The name of the engine that this option can be applied to.
String majorEngineVersion
Indicates the major engine version that the option is available for.
String minimumRequiredMinorEngineVersion
The minimum required engine version for the option to be applied.
Boolean portRequired
Specifies whether the option requires a port.
Integer defaultPort
If the option requires a port, specifies the default port for the option.
SdkInternalList<T> optionsDependedOn
The options that are prerequisites for this option.
SdkInternalList<T> optionsConflictsWith
The options that conflict with this option.
Boolean persistent
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.
Boolean permanent
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.
Boolean requiresAutoMinorEngineVersionUpgrade
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.
Boolean vpcOnly
If true, you can only use this option with a DB instance that is in a VPC.
Boolean supportsOptionVersionDowngrade
If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
SdkInternalList<T> optionGroupOptionSettings
The option settings that are available (and the default value) for each option in an option group.
SdkInternalList<T> optionGroupOptionVersions
The versions that are available for the option.
Boolean copyableCrossAccount
Specifies whether the option can be copied across Amazon Web Services accounts.
String settingName
The name of the option group option.
String settingDescription
The description of the option group option.
String defaultValue
The default value for the option group option.
String applyType
The DB engine specific parameter type for the option group option.
String allowedValues
Indicates the acceptable values for the option group option.
Boolean isModifiable
Boolean value where true indicates that this option group option can be changed from the default value.
Boolean isRequired
Boolean value where true indicates that a value must be specified for this option setting of the option group option.
SdkInternalList<T> minimumEngineVersionPerAllowedValue
The minimum DB engine version required for the corresponding allowed value for this option setting.
String name
The name of the option that has settings that you can set.
String value
The current value of the option setting.
String defaultValue
The default value of the option setting.
String description
The description of the option setting.
String applyType
The DB engine specific parameter type.
String dataType
The data type of the option setting.
String allowedValues
The allowed values of the option setting.
Boolean isModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
Boolean isCollection
Indicates if the option setting is part of a collection.
String engine
The engine type of a DB instance.
String engineVersion
The engine version of a DB instance.
String dBInstanceClass
The DB instance class for a DB instance.
String licenseModel
The license model for a DB instance.
String availabilityZoneGroup
The Availability Zone group for a DB instance.
SdkInternalList<T> availabilityZones
A list of Availability Zones for a DB instance.
Boolean multiAZCapable
Indicates whether a DB instance is Multi-AZ capable.
Boolean readReplicaCapable
Indicates whether a DB instance can have a read replica.
Boolean vpc
Indicates whether a DB instance is in a VPC.
Boolean supportsStorageEncryption
Indicates whether a DB instance supports encrypted storage.
String storageType
Indicates the storage type for a DB instance.
Boolean supportsIops
Indicates whether a DB instance supports provisioned IOPS.
Boolean supportsEnhancedMonitoring
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
Boolean supportsIAMDatabaseAuthentication
Indicates whether a DB instance supports IAM database authentication.
Boolean supportsPerformanceInsights
True if a DB instance supports Performance Insights, otherwise false.
Integer minStorageSize
Minimum storage size for a DB instance.
Integer maxStorageSize
Maximum storage size for a DB instance.
Integer minIopsPerDbInstance
Minimum total provisioned IOPS for a DB instance.
Integer maxIopsPerDbInstance
Maximum total provisioned IOPS for a DB instance.
Double minIopsPerGib
Minimum provisioned IOPS per GiB for a DB instance.
Double maxIopsPerGib
Maximum provisioned IOPS per GiB for a DB instance.
SdkInternalList<T> availableProcessorFeatures
A list of the available processor features for the DB instance class of a DB instance.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes.
Boolean supportsStorageAutoscaling
Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
Boolean supportsKerberosAuthentication
Whether a DB instance supports Kerberos Authentication.
Boolean outpostCapable
Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
SdkInternalList<T> supportedActivityStreamModes
The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value
[sync, async]
. Aurora MySQL and RDS for Oracle return [async]
only. If Database
Activity Streams isn't supported, the return value is an empty list.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
Boolean supportsClusters
Whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
SdkInternalList<T> supportedNetworkTypes
The network types supported by the DB instance (IPV4
or DUAL
).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Boolean supportsStorageThroughput
Indicates whether a DB instance supports storage throughput.
Integer minStorageThroughputPerDbInstance
Minimum storage throughput for a DB instance.
Integer maxStorageThroughputPerDbInstance
Maximum storage throughput for a DB instance.
Double minStorageThroughputPerIops
Minimum storage throughput to provisioned IOPS ratio for a DB instance.
Double maxStorageThroughputPerIops
Maximum storage throughput to provisioned IOPS ratio for a DB instance.
String arn
The Amazon Resource Name (ARN) of the Outpost.
String parameterName
Specifies the name of the parameter.
String parameterValue
Specifies the value of the parameter.
String description
Provides a description of the parameter.
String source
Indicates the source of the parameter value.
String applyType
Specifies the engine specific parameters type.
String dataType
Specifies the valid data type for the parameter.
String allowedValues
Specifies the valid range of values for the parameter.
Boolean isModifiable
Indicates whether (true
) or not (false
) the parameter can be modified. Some parameters
have security or operational implications that prevent them from being changed.
String minimumEngineVersion
The earliest engine version to which the parameter can apply.
String applyMethod
Indicates when to apply parameter updates.
SdkInternalList<T> supportedEngineModes
The valid DB engine modes.
SdkInternalList<T> logTypesToEnable
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
SdkInternalList<T> logTypesToDisable
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
String action
The type of pending maintenance action that is available for the resource. Valid actions are
system-update
, db-upgrade
, hardware-maintenance
, and
ca-certificate-rotation
.
Date autoAppliedAfterDate
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.
Date forcedApplyDate
The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
String optInStatus
Indicates the type of opt-in request that has been received for the resource.
Date currentApplyDate
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
.
String description
A description providing more detail about the maintenance action.
String dBInstanceClass
The name of the compute and memory capacity class for the DB instance.
Integer allocatedStorage
The allocated storage size for the DB instance specified in gibibytes (GiB).
String masterUserPassword
The master credentials for the DB instance.
Integer port
The port for the DB instance.
Integer backupRetentionPeriod
The number of days for which automated backups are retained.
Boolean multiAZ
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
String engineVersion
The database engine version.
String licenseModel
The license model for the DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
Integer iops
The Provisioned IOPS value for the DB instance.
String dBInstanceIdentifier
The database identifier for the DB instance.
String storageType
The storage type of the DB instance.
String cACertificateIdentifier
The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
String dBSubnetGroupName
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports pendingCloudwatchLogsExports
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean iAMDatabaseAuthenticationEnabled
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
String automationMode
The automation mode of the RDS Custom DB instance: full
or all-paused
. If
full
, the DB instance automates monitoring and instance recovery. If all-paused
, the
instance pauses automation for the duration set by --resume-full-automation-mode-minutes
.
Date resumeFullAutomationModeTime
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
Integer storageThroughput
The storage throughput of the DB instance.
String engine
The database engine of the DB instance.
String dBClusterIdentifier
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String reservedDBInstancesOfferingId
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
String reservedDBInstanceId
Customer-specified identifier to track this reservation.
Example: myreservationID
Integer dBInstanceCount
The number of instances to reserve.
Default: 1
SdkInternalList<T> tags
Integer from
The minimum value in the range.
Integer to
The maximum value in the range.
Integer step
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...
String dBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Boolean forceFailover
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
String dBProxyName
The identifier of the DBProxy
that is associated with the DBProxyTargetGroup
.
String targetGroupName
The identifier of the DBProxyTargetGroup
.
SdkInternalList<T> dBInstanceIdentifiers
One or more DB instance identifiers.
SdkInternalList<T> dBClusterIdentifiers
One or more DB cluster identifiers.
SdkInternalList<T> dBProxyTargets
One or more DBProxyTarget
objects that are created when you register targets with a target group.
String dBClusterIdentifier
The name of the DB cluster to disassociate the IAM role from.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example
arn:aws:iam::123456789012:role/AuroraAccessRole
.
String featureName
The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
String dBInstanceIdentifier
The name of the DB instance to disassociate the IAM role from.
String roleArn
The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example,
arn:aws:iam::123456789012:role/AccessRole
.
String featureName
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about
supported feature names, see DBEngineVersion
.
String subscriptionName
The name of the RDS event notification subscription you want to remove a source identifier from.
String sourceIdentifier
The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
String resourceName
The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
SdkInternalList<T> tagKeys
The tag key (name) of the tag to be removed.
String reservedDBInstanceId
The unique identifier for the reservation.
String reservedDBInstancesOfferingId
The offering identifier.
String dBInstanceClass
The DB instance class for the reserved DB instance.
Date startTime
The time the reservation started.
Integer duration
The duration of the reservation in seconds.
Double fixedPrice
The fixed price charged for this reserved DB instance.
Double usagePrice
The hourly price charged for this reserved DB instance.
String currencyCode
The currency code for the reserved DB instance.
Integer dBInstanceCount
The number of reserved DB instances.
String productDescription
The description of the reserved DB instance.
String offeringType
The offering type of this reserved DB instance.
Boolean multiAZ
Indicates if the reservation applies to Multi-AZ deployments.
String state
The state of the reserved DB instance.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved DB instance.
String reservedDBInstanceArn
The Amazon Resource Name (ARN) for the reserved DB instance.
String leaseId
The unique identifier for the lease associated with the reserved DB instance.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
String reservedDBInstancesOfferingId
The offering identifier.
String dBInstanceClass
The DB instance class for the reserved DB instance.
Integer duration
The duration of the offering in seconds.
Double fixedPrice
The fixed price charged for this offering.
Double usagePrice
The hourly price charged for this offering.
String currencyCode
The currency code for the reserved DB instance offering.
String productDescription
The database engine used by the offering.
String offeringType
The offering type.
Boolean multiAZ
Indicates if the offering applies to Multi-AZ deployments.
SdkInternalList<T> recurringCharges
The recurring price charged to run this reserved DB instance.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to reset.
Boolean resetAllParameters
A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values.
You can't use this parameter if there is a list of parameter names specified for the Parameters
parameter.
SdkInternalList<T> parameters
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this
parameter if the ResetAllParameters
parameter is enabled.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup
.
Boolean resetAllParameters
A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
SdkInternalList<T> parameters
To reset the entire DB parameter group, specify the DBParameterGroup
name and
ResetAllParameters
parameters. To reset specific parameters, provide a list of the following:
ParameterName
and ApplyMethod
. A maximum of 20 parameters can be modified in a single
request.
MySQL
Valid Values (for Apply method): immediate
| pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot
value
for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate
| pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot
value
for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
String dBParameterGroupName
The name of the DB parameter group.
String resourceIdentifier
The ARN of the resource that has pending maintenance actions.
SdkInternalList<T> pendingMaintenanceActionDetails
A list that provides details about the pending maintenance actions for the resource.
SdkInternalList<T> availabilityZones
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Integer backupRetentionPeriod
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
String characterSetName
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
String databaseName
The database name for the restored DB cluster.
String dBClusterIdentifier
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the restored DB cluster.
String dBSubnetGroupName
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
String engine
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql
(for Aurora MySQL)
String engineVersion
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql
(Aurora MySQL), use the following
command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.12.0
, 8.0.mysql_aurora.3.04.0
Integer port
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
String masterUsername
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword
is turned on.
String optionGroupName
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
SdkInternalList<T> tags
Boolean storageEncrypted
A value that indicates whether the restored DB cluster is encrypted.
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services
account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
String sourceEngine
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
String sourceEngineVersion
The version of the database that the backup files were created from.
MySQL versions 5.7 and 8.0 are supported.
Example: 5.7.40
, 8.0.28
String s3BucketName
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
String s3Prefix
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
String s3IngestionRoleArn
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Boolean deletionProtection
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 isn't enabled.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
String domain
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration
String networkType
The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Boolean manageMasterUserPassword
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
String storageType
Specifies the storage type to be associated with the DB cluster.
Valid values: aurora
, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
SdkInternalList<T> availabilityZones
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
String dBClusterIdentifier
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String snapshotIdentifier
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String engine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String engineVersion
The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String dBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String databaseName
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String optionGroupName
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
SdkInternalList<T> tags
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String kmsKeyId
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
isn't encrypted, then the restored
DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
Long backtrackWindow
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String engineMode
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
ScalingConfiguration scalingConfiguration
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean deletionProtection
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String domain
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
String dBClusterInstanceClass
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
String storageType
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB
clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean publiclyAccessible
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration
String networkType
The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
String dBClusterIdentifier
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String restoreType
The type of restore to be performed. You can specify one of the following values:
full-copy
- The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write
- The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType
value, then the new DB cluster is restored as a full copy of the
source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String sourceDBClusterIdentifier
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Date restoreToTime
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime
parameter isn't provided
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Can't be specified if the RestoreType
parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean useLatestRestorableTime
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime
parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String dBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String optionGroupName
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
SdkInternalList<T> tags
String kmsKeyId
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS
key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId
parameter.
If you don't specify a value for the KmsKeyId
parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier
refers to a DB cluster that isn't encrypted, then the restore request is
rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
Long backtrackWindow
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).
Valid for: Aurora MySQL DB clusters only
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean deletionProtection
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
String domain
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
ScalingConfiguration scalingConfiguration
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
String engineMode
The engine mode of the new cluster. Specify provisioned
or serverless
, depending on the
type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or
a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1
cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
String dBClusterInstanceClass
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
String storageType
Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid values: aurora
, aurora-iopt1
(Aurora DB clusters); io1
(Multi-AZ DB
clusters)
Default: aurora
(Aurora DB clusters); io1
(Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Boolean publiclyAccessible
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration
String networkType
The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
String sourceDbClusterResourceId
The resource ID of the source DB cluster from which to restore.
String dBInstanceIdentifier
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
String dBSnapshotIdentifier
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier
is specified.
Must be specified when DBClusterSnapshotIdentifier
isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier
must be the ARN of
the shared DB snapshot.
String dBInstanceClass
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
Integer port
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
String availabilityZone
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
String licenseModel
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
String dBName
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
String engine
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Integer iops
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
String optionGroupName
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> tags
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String domain
Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
String domainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
String domainOu
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
String domainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
SdkInternalList<T> domainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName
, then RDS uses the default
DBParameterGroup
for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
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 isn't enabled. For more information, see Deleting a DB Instance.
Boolean enableCustomerOwnedIp
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
String customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
String backupTarget
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon Web
Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
String networkType
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Integer storageThroughput
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
String dBClusterSnapshotIdentifier
The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier
is specified.
Must be specified when DBSnapshotIdentifier
isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the
DBClusterSnapshotIdentifier
must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
Integer allocatedStorage
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
String dBName
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.
String dBInstanceIdentifier
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
Integer allocatedStorage
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
String dBInstanceClass
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
String engine
The name of the database engine to be used for this instance.
Valid Values: mysql
String masterUsername
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Can't be specified if ManageMasterUserPassword
is turned on.
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.
SdkInternalList<T> dBSecurityGroups
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
SdkInternalList<T> vpcSecurityGroupIds
A list of VPC security groups to associate with this DB instance.
String availabilityZone
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current
endpoint.
String dBSubnetGroupName
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
String preferredMaintenanceWindow
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. For more information, see CreateDBInstance
.
String preferredBackupWindow
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Integer port
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ
deployment, you can't set the AvailabilityZone
parameter.
String engineVersion
The version number of the database engine to use. Choose the latest minor version of your database engine. For
information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
String licenseModel
The license model for this DB instance. Use general-public-license
.
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
String optionGroupName
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
SdkInternalList<T> tags
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise gp2
Boolean storageEncrypted
A value that indicates whether the new DB instance is encrypted or not.
String kmsKeyId
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
Boolean copyTagsToSnapshot
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.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
String sourceEngine
The name of the engine of your source database.
Valid Values: mysql
String sourceEngineVersion
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
String s3BucketName
The name of your Amazon S3 bucket that contains your database backup file.
String s3Prefix
The prefix of your Amazon S3 bucket.
String s3IngestionRoleArn
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
Boolean enablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
String performanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
Boolean deletionProtection
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 isn't enabled. For more information, see Deleting a DB Instance.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
String networkType
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Integer storageThroughput
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
Boolean manageMasterUserPassword
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
String masterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
String sourceDBInstanceIdentifier
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
String targetDBInstanceIdentifier
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Date restoreTime
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
Boolean useLatestRestorableTime
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
String dBInstanceClass
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
Integer port
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
String availabilityZone
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
String dBSubnetGroupName
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Boolean multiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Boolean publiclyAccessible
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
Boolean autoMinorVersionUpgrade
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
String licenseModel
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
String dBName
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
String engine
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
String optionGroupName
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
Boolean copyTagsToSnapshot
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
SdkInternalList<T> tags
String storageType
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String domain
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
String domainIAMRoleName
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom DB instances.
String domainFqdn
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
String domainOu
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
String domainAuthSecretArn
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
Constraints:
Can't be longer than 64 characters.
Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
SdkInternalList<T> domainDnsIps
The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
Constraints:
Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
Example: 123.124.125.126,234.235.236.237
Boolean enableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
SdkInternalList<T> enableCloudwatchLogsExports
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
SdkInternalList<T> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Boolean useDefaultProcessorFeatures
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Boolean deletionProtection
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 isn't enabled. For more information, see Deleting a DB Instance.
String sourceDbiResourceId
The resource ID of the source DB instance from which to restore.
Integer maxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
String sourceDBInstanceAutomatedBackupsArn
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
Boolean enableCustomerOwnedIp
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
String customIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
String backupTarget
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon Web
Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
String networkType
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Integer storageThroughput
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
Integer allocatedStorage
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
String dBSecurityGroupName
The name of the DB security group to revoke ingress from.
String cIDRIP
The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP
is specified,
EC2SecurityGroupName
, EC2SecurityGroupId
and EC2SecurityGroupOwnerId
can't
be provided.
String eC2SecurityGroupName
The name of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.
String eC2SecurityGroupId
The id of the EC2 security group to revoke access from. For VPC DB security groups,
EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.
String eC2SecurityGroupOwnerId
The Amazon Web Services account number of the owner of the EC2 security group specified in the
EC2SecurityGroupName
parameter. The Amazon Web Services access key ID isn't an acceptable value. For
VPC DB security groups, EC2SecurityGroupId
must be provided. Otherwise, EC2SecurityGroupOwnerId and
either EC2SecurityGroupName
or EC2SecurityGroupId
must be provided.
Integer minCapacity
The minimum capacity for an Aurora DB cluster in serverless
DB engine mode.
For Aurora MySQL, valid capacity values are 1
, 2
, 4
, 8
,
16
, 32
, 64
, 128
, and 256
.
For Aurora PostgreSQL, valid capacity values are 2
, 4
, 8
, 16
,
32
, 64
, 192
, and 384
.
The minimum capacity must be less than or equal to the maximum capacity.
Integer maxCapacity
The maximum capacity for an Aurora DB cluster in serverless
DB engine mode.
For Aurora MySQL, valid capacity values are 1
, 2
, 4
, 8
,
16
, 32
, 64
, 128
, and 256
.
For Aurora PostgreSQL, valid capacity values are 2
, 4
, 8
, 16
,
32
, 64
, 192
, and 384
.
The maximum capacity must be greater than or equal to the minimum capacity.
Boolean autoPause
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in
serverless
DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
Integer secondsUntilAutoPause
The time, in seconds, before an Aurora DB cluster in serverless
mode is paused.
Specify a value between 300 and 86,400 seconds.
String timeoutAction
The action to take when the timeout is reached, either ForceApplyCapacityChange
or
RollbackCapacityChange
.
ForceApplyCapacityChange
sets the capacity to the specified value as soon as possible.
RollbackCapacityChange
, the default, ignores the capacity change if a scaling point isn't found in
the timeout period.
If you specify ForceApplyCapacityChange
, connections that prevent Aurora Serverless v1 from finding
a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
Integer secondsBeforeTimeout
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
Integer minCapacity
The minimum capacity for an Aurora DB cluster in serverless
DB engine mode.
Integer maxCapacity
The maximum capacity for an Aurora DB cluster in serverless
DB engine mode.
Boolean autoPause
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 v1 DB cluster, the DB cluster automatically resumes.
Integer secondsUntilAutoPause
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).
String timeoutAction
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1
cluster. The value is either ForceApplyCapacityChange
or RollbackCapacityChange
.
ForceApplyCapacityChange
, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange
ignores the capacity change if a scaling point isn't found in the timeout
period.
Integer secondsBeforeTimeout
The number of seconds before scaling times out. What happens when an attempted scaling action times out is
determined by the TimeoutAction
setting.
Double minCapacity
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
Double maxCapacity
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Double minCapacity
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
Double maxCapacity
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
String regionName
The name of the source Amazon Web Services Region.
String endpoint
The endpoint for the source Amazon Web Services Region endpoint.
String status
The status of the source Amazon Web Services Region.
Boolean supportsDBInstanceAutomatedBackupsReplication
Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
String resourceArn
The Amazon Resource Name (ARN) of the DB cluster, for example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.
String mode
Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
String kmsKeyId
The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Boolean applyImmediately
Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
Boolean engineNativeAuditFieldsIncluded
Specifies whether the database activity stream includes engine-native audit fields. This option applies to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.
String kmsKeyId
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
String kinesisStreamName
The name of the Amazon Kinesis data stream to be used for the database activity stream.
String status
The status of the database activity stream.
String mode
The mode of the database activity stream.
Boolean applyImmediately
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
Boolean engineNativeAuditFieldsIncluded
Indicates whether engine-native audit fields are included in the database activity stream.
String dBClusterIdentifier
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
String sourceDBInstanceArn
The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example,
arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
Integer backupRetentionPeriod
The retention period for the replicated automated backups.
String kmsKeyId
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is
the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for
example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE
.
String preSignedUrl
In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the
StartDBInstanceAutomatedBackupsReplication
operation to call in the Amazon Web Services Region of
the source DB instance. The presigned URL must be a valid request for the
StartDBInstanceAutomatedBackupsReplication
API operation that can run in the Amazon Web Services
Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion
(or
--source-region
for the CLI) instead of specifying PreSignedUrl
manually. Specifying
SourceRegion
autogenerates a presigned URL that is a valid request for the operation that can run in
the source Amazon Web Services Region.
String sourceRegion
String dBInstanceIdentifier
The user-supplied instance identifier.
String exportTaskIdentifier
A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.
String sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
String s3BucketName
The name of the Amazon S3 bucket to export the snapshot or cluster data to.
String iamRoleArn
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
String kmsKeyId
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
String s3Prefix
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
SdkInternalList<T> exportOnly
The data to be exported from the snapshot or cluster. If this parameter is not provided, all of the data is exported. Valid values are the following:
database
- Export all the data from a specified database.
database.table
table-name - Export a table of the snapshot or cluster. This format is valid
only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema
schema-name - Export a database schema of the snapshot or cluster. This
format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table
table-name - Export a table of the database schema. This format is
valid only for RDS for PostgreSQL and Aurora PostgreSQL.
String exportTaskIdentifier
A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.
String sourceArn
The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
SdkInternalList<T> exportOnly
The data exported from the snapshot or cluster. Valid values are the following:
database
- Export all the data from a specified database.
database.table
table-name - Export a table of the snapshot or cluster. This format is valid
only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.
database.schema
schema-name - Export a database schema of the snapshot or cluster. This
format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
database.schema.table
table-name - Export a table of the database schema. This format is
valid only for RDS for PostgreSQL and Aurora PostgreSQL.
Date snapshotTime
The time that the snapshot was created.
Date taskStartTime
The time that the snapshot or cluster export task started.
Date taskEndTime
The time that the snapshot or cluster export task ended.
String s3Bucket
The Amazon S3 bucket that the snapshot or cluster is exported to.
String s3Prefix
The Amazon S3 bucket prefix that is the file name and path of the exported data.
String iamRoleArn
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.
String kmsKeyId
The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.
String status
The progress status of the export task. The status can be one of the following:
CANCELED
CANCELING
COMPLETE
FAILED
IN_PROGRESS
STARTING
Integer percentProgress
The progress of the snapshot or cluster export task as a percentage.
Integer totalExtractedDataInGB
The total amount of data exported, in gigabytes.
String failureCause
The reason the export failed, if it failed.
String warningMessage
A warning about the snapshot or cluster export task.
String sourceType
The type of source for the export.
String resourceArn
The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example,
arn:aws:rds:us-east-1:12345667890:cluster:das-cluster
.
Boolean applyImmediately
Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
String kmsKeyId
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
String kinesisStreamName
The name of the Amazon Kinesis data stream used for the database activity stream.
String status
The status of the database activity stream.
String dBClusterIdentifier
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
String sourceDBInstanceArn
The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automate backups, for
example, arn:aws:rds:us-west-2:123456789012:db:mydatabase
.
String subnetIdentifier
The identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
Outpost subnetOutpost
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
String subnetStatus
The status of the subnet.
String blueGreenDeploymentIdentifier
The unique identifier of the blue/green deployment.
Constraints:
Must match an existing blue/green deployment identifier.
Integer switchoverTimeout
The amount of time, in seconds, for the switchover to complete.
Default: 300
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
BlueGreenDeployment blueGreenDeployment
String sourceMember
The Amazon Resource Name (ARN) of a resource in the blue environment.
String targetMember
The Amazon Resource Name (ARN) of a resource in the green environment.
String status
The switchover status of a resource in a blue/green deployment.
Values:
PROVISIONING
- The resource is being prepared to switch over.
AVAILABLE
- The resource is ready to switch over.
SWITCHOVER_IN_PROGRESS
- The resource is being switched over.
SWITCHOVER_COMPLETED
- The resource has been switched over.
SWITCHOVER_FAILED
- The resource attempted to switch over but failed.
MISSING_SOURCE
- The source resource has been deleted.
MISSING_TARGET
- The target resource has been deleted.
String globalClusterIdentifier
The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing global database cluster (Aurora global database).
String targetDbClusterIdentifier
The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
String dBInstanceIdentifier
The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Oracle read replica DB instance.
String key
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}_.:/=+\\-@]*)$").
String value
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}_.:/=+\\-@]*)$").
String state
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering
> unavailable
> available
> unavailable
> available
String reason
The reason for the current health State
of the RDS Proxy target.
String description
A description of the health of the RDS Proxy target. If the State
is AVAILABLE
, a
description is not included.
String timezoneName
The name of the time zone.
String engine
The name of the upgrade target database engine.
String engineVersion
The version number of the upgrade target database engine.
String description
The version of the database engine that a DB instance can be upgraded to.
Boolean autoUpgrade
A value that indicates whether the target version is applied to any source DB instances that have
AutoMinorVersionUpgrade
set to true.
Boolean isMajorVersionUpgrade
A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SdkInternalList<T> supportedEngineModes
A list of the supported DB engine modes for the target engine version.
Boolean supportsParallelQuery
A value that indicates whether you can use Aurora parallel query with the target engine version.
Boolean supportsGlobalDatabases
A value that indicates whether you can use Aurora global databases with the target engine version.
Boolean supportsBabelfish
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
Boolean supportsLocalWriteForwarding
A value that indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
String description
A user-specified description about the authentication used by a proxy to log in as a specific database user.
String userName
The name of the database user to which the proxy connects.
String authScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
String secretArn
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
String iAMAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for
connections to the proxy. The ENABLED
value is valid only for proxies with RDS for Microsoft SQL
Server.
String clientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
String description
A user-specified description about the authentication used by a proxy to log in as a specific database user.
String userName
The name of the database user to which the proxy connects.
String authScheme
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
String secretArn
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
String iAMAuth
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for
connections to the proxy. The ENABLED
value is valid only for proxies with RDS for Microsoft SQL
Server.
String clientPasswordAuthType
The type of authentication the proxy uses for connections from clients.
SdkInternalList<T> storage
Valid storage options for your DB instance.
SdkInternalList<T> validProcessorFeatures
Valid processor features for your DB instance.
String storageType
The valid storage types for your DB instance. For example: gp2, gp3, io1.
SdkInternalList<T> storageSize
The valid range of storage in gibibytes (GiB). For example, 100 to 16,384.
SdkInternalList<T> provisionedIops
The valid range of provisioned IOPS. For example, 1000-256,000.
SdkInternalList<T> iopsToStorageRatio
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.
Boolean supportsStorageAutoscaling
Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
SdkInternalList<T> provisionedStorageThroughput
The valid range of provisioned storage throughput. For example, 500-4,000 mebibytes per second (MiBps).
SdkInternalList<T> storageThroughputToIopsRatio
The valid range of storage throughput to provisioned IOPS ratios. For example, 0-0.25.
Copyright © 2023. All rights reserved.