2026/02/10 - Amazon Relational Database Service - 19 updated api methods
Changes This release adds backup configuration for RDS and Aurora restores, letting customers set backup retention period and preferred backup window during restore. It also enables viewing backup settings when describing snapshots or automated backups for instances and clusters.
{'DBClusterSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier='string',
TargetDBClusterSnapshotIdentifier='string',
KmsKeyId='string',
PreSignedUrl='string',
CopyTags=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
Constraints:
Must specify a valid source 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. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.
Example: my-cluster-snapshot1
string
[REQUIRED]
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
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
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.
boolean
Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'StorageType': 'string',
'StorageThroughput': 123,
'DbClusterResourceId': 'string',
'DBSystemId': 'string'
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
(string) --
DBClusterSnapshotIdentifier (string) --
The identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
The name of the database engine for this DB cluster snapshot.
EngineMode (string) --
The engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Status (string) --
The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Port (integer) --
The port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
The VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
The master username for this DB cluster snapshot.
EngineVersion (string) --
The version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
The license model information for this DB cluster snapshot.
SnapshotType (string) --
The type of the DB cluster snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Indicates whether the DB cluster snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
StorageType (string) --
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
DbClusterResourceId (string) --
The resource ID of the DB cluster that this DB cluster snapshot was created from.
DBSystemId (string) --
Reserved for future use.
{'DBSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.copy_db_snapshot(
SourceDBSnapshotIdentifier='string',
TargetDBSnapshotIdentifier='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CopyTags=True|False,
PreSignedUrl='string',
OptionGroupName='string',
TargetCustomAvailabilityZone='string',
SnapshotTarget='string',
CopyOptionGroup=True|False,
SnapshotAvailabilityZone='string'
)
string
[REQUIRED]
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 you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. You can also specify an ARN of a snapshot that is in a different account and a different Amazon Web Services Region. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.
Constraints:
Must specify a valid source 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
[REQUIRED]
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
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.
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
boolean
Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
string
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
string
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
string
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
string
Configures the location where RDS will store copied snapshots.
Valid Values:
local (Dedicated Local Zone)
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
boolean
Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
string
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SnapshotTarget': 'string',
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotDatabaseTime': datetime(2015, 1, 1),
'DBSystemId': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'SnapshotAvailabilityZone': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
StorageThroughput (integer) --
Specifies the storage throughput for the DB snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Indicates whether the DB snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ProcessorFeatures (list) --
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime (datetime) --
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.
DBSystemId (string) --
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
MultiTenant (boolean) --
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
SnapshotAvailabilityZone (string) --
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
{'DBClusterSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.create_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string',
DBClusterIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
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
[REQUIRED]
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
list
The tags to be assigned to the DB cluster snapshot.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'StorageType': 'string',
'StorageThroughput': 123,
'DbClusterResourceId': 'string',
'DBSystemId': 'string'
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
(string) --
DBClusterSnapshotIdentifier (string) --
The identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
The name of the database engine for this DB cluster snapshot.
EngineMode (string) --
The engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Status (string) --
The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Port (integer) --
The port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
The VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
The master username for this DB cluster snapshot.
EngineVersion (string) --
The version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
The license model information for this DB cluster snapshot.
SnapshotType (string) --
The type of the DB cluster snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Indicates whether the DB cluster snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
StorageType (string) --
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
DbClusterResourceId (string) --
The resource ID of the DB cluster that this DB cluster snapshot was created from.
DBSystemId (string) --
Reserved for future use.
{'DBSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
See also: AWS API Documentation
Request Syntax
client.create_db_snapshot(
DBSnapshotIdentifier='string',
DBInstanceIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
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
[REQUIRED]
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SnapshotTarget': 'string',
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotDatabaseTime': datetime(2015, 1, 1),
'DBSystemId': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'SnapshotAvailabilityZone': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
StorageThroughput (integer) --
Specifies the storage throughput for the DB snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Indicates whether the DB snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ProcessorFeatures (list) --
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime (datetime) --
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.
DBSystemId (string) --
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
MultiTenant (boolean) --
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
SnapshotAvailabilityZone (string) --
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
{'DBClusterAutomatedBackup': {'PreferredBackupWindow': 'string'}}
Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.
See also: AWS API Documentation
Request Syntax
client.delete_db_cluster_automated_backup(
DbClusterResourceId='string'
)
string
[REQUIRED]
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
dict
Response Syntax
{
'DBClusterAutomatedBackup': {
'Engine': 'string',
'VpcId': 'string',
'DBClusterAutomatedBackupsArn': 'string',
'DBClusterIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'MasterUsername': 'string',
'DbClusterResourceId': 'string',
'Region': 'string',
'LicenseModel': 'string',
'Status': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ClusterCreateTime': datetime(2015, 1, 1),
'StorageEncrypted': True|False,
'AllocatedStorage': 123,
'EngineVersion': 'string',
'DBClusterArn': 'string',
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'EngineMode': 'string',
'AvailabilityZones': [
'string',
],
'Port': 123,
'KmsKeyId': 'string',
'StorageType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
DBClusterAutomatedBackup (dict) --
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
Engine (string) --
The name of the database engine for this automated backup.
VpcId (string) --
The VPC ID associated with the DB cluster.
DBClusterAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DBClusterIdentifier (string) --
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to:
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
MasterUsername (string) --
The master user name of the automated backup.
DbClusterResourceId (string) --
The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
LicenseModel (string) --
The license model information for this DB cluster automated backup.
Status (string) --
A list of status information for an automated backup:
retained - Automated backups for deleted clusters.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
StorageEncrypted (boolean) --
Indicates whether the source DB cluster is encrypted.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
EngineVersion (string) --
The version of the database engine for the automated backup.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the source DB cluster.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
EngineMode (string) --
The engine mode of the database engine for the automated backup.
AvailabilityZones (list) --
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.
(string) --
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageThroughput (integer) --
The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
{'DBClusterSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.delete_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'StorageType': 'string',
'StorageThroughput': 123,
'DbClusterResourceId': 'string',
'DBSystemId': 'string'
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
(string) --
DBClusterSnapshotIdentifier (string) --
The identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
The name of the database engine for this DB cluster snapshot.
EngineMode (string) --
The engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Status (string) --
The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Port (integer) --
The port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
The VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
The master username for this DB cluster snapshot.
EngineVersion (string) --
The version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
The license model information for this DB cluster snapshot.
SnapshotType (string) --
The type of the DB cluster snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Indicates whether the DB cluster snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
StorageType (string) --
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
DbClusterResourceId (string) --
The resource ID of the DB cluster that this DB cluster snapshot was created from.
DBSystemId (string) --
Reserved for future use.
{'DBInstanceAutomatedBackup': {'PreferredBackupWindow': 'string'}}
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance_automated_backup(
DbiResourceId='string',
DBInstanceAutomatedBackupsArn='string'
)
string
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
string
The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
dict
Response Syntax
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'MultiTenant': True|False,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
}
}
Response Structure
(dict) --
DBInstanceAutomatedBackup (dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
The earliest and latest time a DB instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
The allocated storage size for the automated backup in gibibytes (GiB).
Status (string) --
A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
VpcId (string) --
The VPC ID associated with the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
MasterUsername (string) --
The master user name of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
The license model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
StorageThroughput (integer) --
The storage throughput for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Indicates whether the automated backup is encrypted.
StorageType (string) --
The storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
MultiTenant (boolean) --
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the automated backup.
Valid Values: GP3 | IO2
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
{'DBSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
See also: AWS API Documentation
Request Syntax
client.delete_db_snapshot(
DBSnapshotIdentifier='string'
)
string
[REQUIRED]
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SnapshotTarget': 'string',
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotDatabaseTime': datetime(2015, 1, 1),
'DBSystemId': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'SnapshotAvailabilityZone': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
StorageThroughput (integer) --
Specifies the storage throughput for the DB snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Indicates whether the DB snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ProcessorFeatures (list) --
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime (datetime) --
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.
DBSystemId (string) --
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
MultiTenant (boolean) --
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
SnapshotAvailabilityZone (string) --
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
{'DBClusterAutomatedBackups': {'PreferredBackupWindow': 'string'}}
Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
See also: AWS API Documentation
Request Syntax
client.describe_db_cluster_automated_backups(
DbClusterResourceId='string',
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.
string
(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.
list
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.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'DBClusterAutomatedBackups': [
{
'Engine': 'string',
'VpcId': 'string',
'DBClusterAutomatedBackupsArn': 'string',
'DBClusterIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'MasterUsername': 'string',
'DbClusterResourceId': 'string',
'Region': 'string',
'LicenseModel': 'string',
'Status': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ClusterCreateTime': datetime(2015, 1, 1),
'StorageEncrypted': True|False,
'AllocatedStorage': 123,
'EngineVersion': 'string',
'DBClusterArn': 'string',
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'EngineMode': 'string',
'AvailabilityZones': [
'string',
],
'Port': 123,
'KmsKeyId': 'string',
'StorageType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
DBClusterAutomatedBackups (list) --
A list of DBClusterAutomatedBackup backups.
(dict) --
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
Engine (string) --
The name of the database engine for this automated backup.
VpcId (string) --
The VPC ID associated with the DB cluster.
DBClusterAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DBClusterIdentifier (string) --
The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to:
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
MasterUsername (string) --
The master user name of the automated backup.
DbClusterResourceId (string) --
The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
LicenseModel (string) --
The license model information for this DB cluster automated backup.
Status (string) --
A list of status information for an automated backup:
retained - Automated backups for deleted clusters.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
StorageEncrypted (boolean) --
Indicates whether the source DB cluster is encrypted.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
EngineVersion (string) --
The version of the database engine for the automated backup.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the source DB cluster.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
EngineMode (string) --
The engine mode of the database engine for the automated backup.
AvailabilityZones (list) --
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.
(string) --
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB cluster
Valid Values: 1150-65535
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageThroughput (integer) --
The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
{'DBClusterSnapshots': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_db_cluster_snapshots(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbClusterResourceId='string'
)
string
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
string
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
string
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
list
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.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
boolean
Specifies 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
Specifies 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
A specific DB cluster resource ID to describe.
dict
Response Syntax
{
'Marker': 'string',
'DBClusterSnapshots': [
{
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'StorageType': 'string',
'StorageThroughput': 123,
'DbClusterResourceId': 'string',
'DBSystemId': 'string'
},
]
}
Response Structure
(dict) --
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
Marker (string) --
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBClusterSnapshots (list) --
Provides a list of DB cluster snapshots for the user.
(dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
(string) --
DBClusterSnapshotIdentifier (string) --
The identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
The name of the database engine for this DB cluster snapshot.
EngineMode (string) --
The engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Status (string) --
The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
Port (integer) --
The port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
The VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
The master username for this DB cluster snapshot.
EngineVersion (string) --
The version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
The license model information for this DB cluster snapshot.
SnapshotType (string) --
The type of the DB cluster snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Indicates whether the DB cluster snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
StorageType (string) --
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
DbClusterResourceId (string) --
The resource ID of the DB cluster that this DB cluster snapshot was created from.
DBSystemId (string) --
Reserved for future use.
{'DBInstanceAutomatedBackups': {'PreferredBackupWindow': 'string'}}
Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
See also: AWS API Documentation
Request Syntax
client.describe_db_instance_automated_backups(
DbiResourceId='string',
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DBInstanceAutomatedBackupsArn='string'
)
string
The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
string
(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.
list
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.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
string
The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
string
The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
dict
Response Syntax
{
'Marker': 'string',
'DBInstanceAutomatedBackups': [
{
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'MultiTenant': True|False,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBInstanceAutomatedBackups (list) --
A list of DBInstanceAutomatedBackup instances.
(dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
The earliest and latest time a DB instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
The allocated storage size for the automated backup in gibibytes (GiB).
Status (string) --
A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
VpcId (string) --
The VPC ID associated with the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
MasterUsername (string) --
The master user name of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
The license model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
StorageThroughput (integer) --
The storage throughput for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Indicates whether the automated backup is encrypted.
StorageType (string) --
The storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
MultiTenant (boolean) --
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the automated backup.
Valid Values: GP3 | IO2
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
{'DBSnapshots': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Returns information about DB snapshots. This API action supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_db_snapshots(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string'
)
string
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
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
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.
list
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.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribeDBRecommendations
DescribeDBShardGroups
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
boolean
Specifies 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
Specifies 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
A specific DB resource ID to describe.
dict
Response Syntax
{
'Marker': 'string',
'DBSnapshots': [
{
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SnapshotTarget': 'string',
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotDatabaseTime': datetime(2015, 1, 1),
'DBSystemId': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'SnapshotAvailabilityZone': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSnapshots action.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBSnapshots (list) --
A list of DBSnapshot instances.
(dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
StorageThroughput (integer) --
Specifies the storage throughput for the DB snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Indicates whether the DB snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ProcessorFeatures (list) --
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime (datetime) --
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.
DBSystemId (string) --
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
MultiTenant (boolean) --
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
SnapshotAvailabilityZone (string) --
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
{'DBSnapshot': {'BackupRetentionPeriod': 'integer',
'PreferredBackupWindow': 'string'}}
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MariaDB, MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.
See also: AWS API Documentation
Request Syntax
client.modify_db_snapshot(
DBSnapshotIdentifier='string',
EngineVersion='string',
OptionGroupName='string'
)
string
[REQUIRED]
The identifier of the DB snapshot to modify.
string
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MariaDB
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MariaDB DB snapshot engine version in the Amazon RDS User Guide.
MySQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.
Oracle
21.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 21.0.0.0.ru-2022-01.rur-2022-01.r1, 21.0.0.0.ru-2022-04.rur-2022-04.r1, 21.0.0.0.ru-2022-07.rur-2022-07.r1, 21.0.0.0.ru-2022-10.rur-2022-10.r1, 21.0.0.0.ru-2023-01.rur-2023-01.r1 and 21.0.0.0.ru-2023-01.rur-2023-01.r2 DB snapshots)
19.0.0.0.ru-2025-04.rur-2025-04.r1 (supported for 19.0.0.0.ru-2019-07.rur-2019-07.r1, 19.0.0.0.ru-2019-10.rur-2019-10.r1 and 0.0.0.ru-2020-01.rur-2020-01.r1 DB snapshots)
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 a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.
string
The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SnapshotTarget': 'string',
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotDatabaseTime': datetime(2015, 1, 1),
'DBSystemId': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'SnapshotAvailabilityZone': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
StorageThroughput (integer) --
Specifies the storage throughput for the DB snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Indicates whether the DB snapshot is encrypted.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
ProcessorFeatures (list) --
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotDatabaseTime (datetime) --
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.
DBSystemId (string) --
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.
MultiTenant (boolean) --
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
SnapshotAvailabilityZone (string) --
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
{'BackupRetentionPeriod': 'integer', 'PreferredBackupWindow': 'string'}
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.restore_db_cluster_from_snapshot(
AvailabilityZones=[
'string',
],
DBClusterIdentifier='string',
SnapshotIdentifier='string',
Engine='string',
EngineVersion='string',
Port=123,
DBSubnetGroupName='string',
DatabaseName='string',
OptionGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
EngineMode='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DBClusterParameterGroupName='string',
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
DBClusterInstanceClass='string',
StorageType='string',
Iops=123,
PubliclyAccessible=True|False,
NetworkType='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0,
'SecondsUntilAutoPause': 123
},
RdsCustomClusterConfiguration={
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
EngineLifecycleSupport='string',
TagSpecifications=[
{
'ResourceType': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
list
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
(string) --
string
[REQUIRED]
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
[REQUIRED]
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
[REQUIRED]
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
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
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
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
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
string
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.
list
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(string) --
list
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
string
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
list
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, slowquery, and iam-db-auth-error.
RDS for PostgreSQL
Possible values are postgresql, upgrade, and iam-db-auth-error.
Aurora MySQL
Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.
Aurora PostgreSQL
Possible value are instance, postgresql, and iam-db-auth-error.
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) --
string
The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
dict
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout (integer) --
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
string
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to enable deletion protection for the DB cluster. 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
Specifies 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
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
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
string
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
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
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
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 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
string
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
dict
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
SecondsUntilAutoPause (integer) --
Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
dict
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
boolean
Specifies whether to turn on Performance Insights for the DB cluster.
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
integer
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
integer
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: Uses existing setting
Constraints:
Must be a value from 1 to 35.
string
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
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
The life cycle type for this DB cluster.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
list
Tags to assign to resources associated with the DB cluster.
Valid Values:
cluster-auto-backup - The DB cluster's automated backup.
(dict) --
The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Valid Values:
auto-backup - The DB instance's automated backup.
cluster-auto-backup - The DB cluster's automated backup.
Tags (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'UpgradeRolloutOrder': 'first'|'second'|'last',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'StorageType': 'string',
'AllocatedStorage': 123,
'RdsCustomClusterConfiguration': {
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
'Iops': 123,
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
}
},
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'RdsCustomClusterConfiguration': {
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string',
'OU': 'string',
'AuthSecretArn': 'string',
'DnsIps': [
'string',
]
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalClusterIdentifier': 'string',
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'NetworkType': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0,
'SecondsUntilAutoPause': 123
},
'ServerlessV2PlatformVersion': 'string',
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'DatabaseInsightsMode': 'standard'|'advanced',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
'AwsBackupRecoveryPointArn': 'string',
'LimitlessDatabase': {
'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error',
'MinRequiredACU': 123.0
},
'ClusterScalabilityType': 'standard'|'limitless',
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'EngineLifecycleSupport': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
(string) --
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
The name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
The current state of this DB cluster.
PercentProgress (string) --
The progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
The connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
The custom endpoints associated with the DB cluster.
(string) --
MultiAZ (boolean) --
Indicates whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The database engine used for this DB cluster.
EngineVersion (string) --
The version of the database engine.
LatestRestorableTime (datetime) --
The latest time to which a database can be restored with point-in-time restore.
Port (integer) --
The port that the database engine is listening on.
MasterUsername (string) --
The master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
The list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow (string) --
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
UpgradeRolloutOrder (string) --
This data type represents the order in which the clusters are upgraded.
[first] - Typically used for development or testing environments.
[second] - Default order for resources not specifically configured.
[last] - Usually reserved for production environments.
ReplicationSourceIdentifier (string) --
The identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
(string) --
StatusInfos (list) --
Reserved for future use.
(dict) --
Reserved for future use.
StatusType (string) --
Reserved for future use.
Normal (boolean) --
Reserved for future use.
Status (string) --
Reserved for future use.
Message (string) --
Reserved for future use.
DBClusterMembers (list) --
The list of DB instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Indicates whether the cluster member is the primary DB instance for the DB cluster.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
VpcSecurityGroups (list) --
The list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active.
HostedZoneId (string) --
The ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Indicates whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
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.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
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.
(string) --
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
PendingModifiedValues (dict) --
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string) --
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
StorageType (string) --
The storage type for the DB cluster.
AllocatedStorage (integer) --
The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
RdsCustomClusterConfiguration (dict) --
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
CertificateDetails (dict) --
The details of the DB instance’s server certificate.
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.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
ScalingConfigurationInfo (dict) --
The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
RdsCustomClusterConfiguration (dict) --
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
DeletionProtection (boolean) --
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name (FQDN) of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for the DB instance or cluster.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
DnsIps (list) --
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
(string) --
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
NetworkType (string) --
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
SecondsUntilAutoPause (integer) --
The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again.
This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
ServerlessV2PlatformVersion (string) --
The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
DatabaseInsightsMode (string) --
The mode of Database Insights that is enabled for the DB cluster.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for Aurora DB clusters and 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
DBSystemId (string) --
Reserved for future use.
MasterUserSecret (dict) --
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
LocalWriteForwardingStatus (string) --
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
LimitlessDatabase (dict) --
The details for Aurora Limitless Database.
Status (string) --
The status of Aurora Limitless Database.
MinRequiredACU (float) --
The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
ClusterScalabilityType (string) --
The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
CertificateDetails (dict) --
The details of the DB instance’s server certificate.
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.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
EngineLifecycleSupport (string) --
The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
{'BackupRetentionPeriod': 'integer', 'PreferredBackupWindow': 'string'}
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.restore_db_cluster_to_point_in_time(
DBClusterIdentifier='string',
RestoreType='string',
SourceDBClusterIdentifier='string',
RestoreToTime=datetime(2015, 1, 1),
UseLatestRestorableTime=True|False,
Port=123,
DBSubnetGroupName='string',
OptionGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
DBClusterParameterGroupName='string',
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
DBClusterInstanceClass='string',
StorageType='string',
PubliclyAccessible=True|False,
Iops=123,
NetworkType='string',
SourceDbClusterResourceId='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0,
'SecondsUntilAutoPause': 123
},
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
EngineMode='string',
RdsCustomClusterConfiguration={
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
EngineLifecycleSupport='string',
TagSpecifications=[
{
'ResourceType': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
string
[REQUIRED]
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
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
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
datetime
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
Specifies 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
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
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
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.
list
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(string) --
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
string
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
list
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, slowquery, and iam-db-auth-error.
RDS for PostgreSQL
Possible values are postgresql, upgrade, and iam-db-auth-error.
Aurora MySQL
Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.
Aurora PostgreSQL
Possible value are instance, postgresql, and iam-db-auth-error.
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) --
string
The name of the custom DB cluster parameter group to associate with this DB cluster.
If the DBClusterParameterGroupName parameter 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
Specifies whether to enable deletion protection for the DB cluster. 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
Specifies 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
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
The name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
string
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
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
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 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
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
string
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
The resource ID of the source DB cluster from which to restore.
dict
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
SecondsUntilAutoPause (integer) --
Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
dict
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --
Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout (integer) --
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
string
The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless 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. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode serverless.
Valid for: Aurora DB clusters only
dict
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
boolean
Specifies whether to turn on Performance Insights for the DB cluster.
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
integer
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
integer
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: Uses existing setting
Constraints:
Must be a value from 1 to 35.
string
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
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
The life cycle type for this DB cluster.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
list
Tags to assign to resources associated with the DB cluster.
Valid Values:
cluster-auto-backup - The DB cluster's automated backup.
(dict) --
The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Valid Values:
auto-backup - The DB instance's automated backup.
cluster-auto-backup - The DB cluster's automated backup.
Tags (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'UpgradeRolloutOrder': 'first'|'second'|'last',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'StorageType': 'string',
'AllocatedStorage': 123,
'RdsCustomClusterConfiguration': {
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
'Iops': 123,
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
}
},
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'RdsCustomClusterConfiguration': {
'InterconnectSubnetId': 'string',
'TransitGatewayMulticastDomainId': 'string',
'ReplicaMode': 'open-read-only'|'mounted'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'StorageThroughput': 123,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string',
'OU': 'string',
'AuthSecretArn': 'string',
'DnsIps': [
'string',
]
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalClusterIdentifier': 'string',
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'NetworkType': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0,
'SecondsUntilAutoPause': 123
},
'ServerlessV2PlatformVersion': 'string',
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'DatabaseInsightsMode': 'standard'|'advanced',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
'AwsBackupRecoveryPointArn': 'string',
'LimitlessDatabase': {
'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error',
'MinRequiredACU': 123.0
},
'ClusterScalabilityType': 'standard'|'limitless',
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'EngineLifecycleSupport': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.
AvailabilityZones (list) --
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
(string) --
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
The name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
The current state of this DB cluster.
PercentProgress (string) --
The progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
The connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
The custom endpoints associated with the DB cluster.
(string) --
MultiAZ (boolean) --
Indicates whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The database engine used for this DB cluster.
EngineVersion (string) --
The version of the database engine.
LatestRestorableTime (datetime) --
The latest time to which a database can be restored with point-in-time restore.
Port (integer) --
The port that the database engine is listening on.
MasterUsername (string) --
The master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
The list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow (string) --
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
UpgradeRolloutOrder (string) --
This data type represents the order in which the clusters are upgraded.
[first] - Typically used for development or testing environments.
[second] - Default order for resources not specifically configured.
[last] - Usually reserved for production environments.
ReplicationSourceIdentifier (string) --
The identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
(string) --
StatusInfos (list) --
Reserved for future use.
(dict) --
Reserved for future use.
StatusType (string) --
Reserved for future use.
Normal (boolean) --
Reserved for future use.
Status (string) --
Reserved for future use.
Message (string) --
Reserved for future use.
DBClusterMembers (list) --
The list of DB instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Indicates whether the cluster member is the primary DB instance for the DB cluster.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
VpcSecurityGroups (list) --
The list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active.
HostedZoneId (string) --
The ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Indicates whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
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.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.
ClusterCreateTime (datetime) --
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
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.
(string) --
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
PendingModifiedValues (dict) --
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string) --
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
StorageType (string) --
The storage type for the DB cluster.
AllocatedStorage (integer) --
The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
RdsCustomClusterConfiguration (dict) --
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
CertificateDetails (dict) --
The details of the DB instance’s server certificate.
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.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
ScalingConfigurationInfo (dict) --
The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
RdsCustomClusterConfiguration (dict) --
Reserved for future use.
InterconnectSubnetId (string) --
Reserved for future use.
TransitGatewayMulticastDomainId (string) --
Reserved for future use.
ReplicaMode (string) --
Reserved for future use.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageThroughput (integer) --
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
DeletionProtection (boolean) --
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name (FQDN) of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for the DB instance or cluster.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
DnsIps (list) --
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
(string) --
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
NetworkType (string) --
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.
SecondsUntilAutoPause (integer) --
The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again.
This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
ServerlessV2PlatformVersion (string) --
The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
DatabaseInsightsMode (string) --
The mode of Database Insights that is enabled for the DB cluster.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for Aurora DB clusters and 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
DBSystemId (string) --
Reserved for future use.
MasterUserSecret (dict) --
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
LocalWriteForwardingStatus (string) --
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
LimitlessDatabase (dict) --
The details for Aurora Limitless Database.
Status (string) --
The status of Aurora Limitless Database.
MinRequiredACU (float) --
The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs).
ClusterScalabilityType (string) --
The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
CertificateDetails (dict) --
The details of the DB instance’s server certificate.
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.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
EngineLifecycleSupport (string) --
The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
{'BackupRetentionPeriod': 'integer', 'PreferredBackupWindow': 'string'}
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version.
See also: AWS API Documentation
Request Syntax
client.restore_db_instance_from_db_snapshot(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
DBInstanceClass='string',
Port=123,
AvailabilityZone='string',
DBSubnetGroupName='string',
MultiAZ=True|False,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
DBName='string',
Engine='string',
Iops=123,
StorageThroughput=123,
OptionGroupName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
VpcSecurityGroupIds=[
'string',
],
Domain='string',
DomainFqdn='string',
DomainOu='string',
DomainAuthSecretArn='string',
DomainDnsIps=[
'string',
],
CopyTagsToSnapshot=True|False,
DomainIAMRoleName='string',
EnableIAMDatabaseAuthentication=True|False,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DBParameterGroupName='string',
DeletionProtection=True|False,
EnableCustomerOwnedIp=True|False,
NetworkType='string',
BackupTarget='string',
CustomIamInstanceProfile='string',
AllocatedStorage=123,
DBClusterSnapshotIdentifier='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
DedicatedLogVolume=True|False,
CACertificateIdentifier='string',
EngineLifecycleSupport='string',
AdditionalStorageVolumes=[
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string'
)
string
[REQUIRED]
The 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
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DB snapshot.
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
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
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
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
The name of the DB subnet group to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
boolean
Specifies 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
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.
For more information, see CreateDBInstance.
boolean
Specifies whether to automatically apply minor version upgrades to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
string
License model information for the restored DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license | marketplace-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
Default: Same as the source.
string
The name of the database for the restored DB instance.
This parameter only applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply to the other engines or to RDS Custom DB instances.
string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
integer
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
integer
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
string
Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp3
string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
list
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) --
string
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 Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
string
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
string
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
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
list
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) --
boolean
Specifies 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
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
Specifies 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.
list
The list of logs for the restored DB instance to export to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
(string) --
list
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
string
The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB 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.
boolean
Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
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
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.
string
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are local (Dedicated Local Zone), 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
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.
integer
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
This setting isn't valid for RDS for SQL Server.
string
The identifier for the 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.
integer
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
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
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.
boolean
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
string
The life cycle type for this DB instance.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
list
A list of additional storage volumes to create for the DB instance. You can create up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) -- [REQUIRED]
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
list
Tags to assign to resources associated with the DB instance.
Valid Values:
auto-backup - The DB instance's automated backup.
(dict) --
The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Valid Values:
auto-backup - The DB instance's automated backup.
cluster-auto-backup - The DB cluster's automated backup.
Tags (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Applies to RDS for Oracle only.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'UpgradeRolloutOrder': 'first'|'second'|'last',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'MultiTenant': True|False,
'IAMDatabaseAuthenticationEnabled': True|False,
'DedicatedLogVolume': True|False,
'Engine': 'string',
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string',
'OU': 'string',
'AuthSecretArn': 'string',
'DnsIps': [
'string',
]
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'DatabaseInsightsMode': 'standard'|'advanced',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomerOwnedIpEnabled': True|False,
'NetworkType': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AwsBackupRecoveryPointArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'ReadReplicaSourceDBClusterIdentifier': 'string',
'PercentProgress': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'IsStorageConfigUpgradeAvailable': True|False,
'EngineLifecycleSupport': 'string',
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'StorageVolumeStatus': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'StorageVolumeStatus': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstanceIdentifier (string) --
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
Engine (string) --
The database engine used for this DB instance.
DBInstanceStatus (string) --
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
Endpoint (dict) --
The connection endpoint for the DB instance.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
The amount of storage in gibibytes (GiB) allocated for the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
DBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active.
DBParameterGroups (list) --
The list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
DBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates. Valid values are:
applying: The parameter group change is being applied to the database.
failed-to-apply: The parameter group is in an invalid state.
in-sync: The parameter group change is synchronized with the database.
pending-database-upgrade: The parameter group change will be applied after the DB instance is upgraded.
pending-reboot: The parameter group change will be applied after the DB instance reboots.
AvailabilityZone (string) --
The name of the Availability Zone where the DB instance is located.
DBSubnetGroup (dict) --
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
The status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
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) --
PreferredMaintenanceWindow (string) --
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
UpgradeRolloutOrder (string) --
This data type represents the order in which the instances are upgraded.
[first] - Typically used for development or testing environments.
[second] - Default order for resources not specifically configured.
[last] - Usually reserved for production environments.
PendingModifiedValues (dict) --
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
StorageThroughput (integer) --
The storage throughput of the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string) --
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
ResumeFullAutomationModeTime (datetime) --
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.
MultiTenant (boolean) --
Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
Engine (string) --
The database engine of the DB instance.
AdditionalStorageVolumes (list) --
The additional storage volume modifications that are pending for the DB instance.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
LatestRestorableTime (datetime) --
The latest time to which a database in this DB instance can be restored with point-in-time restore.
MultiAZ (boolean) --
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
EngineVersion (string) --
The version of the database engine.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
ReadReplicaSourceDBInstanceIdentifier (string) --
The identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
The identifiers of the read replicas associated with this DB instance.
(string) --
ReadReplicaDBClusterIdentifiers (list) --
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.
(string) --
ReplicaMode (string) --
The open mode of a Db2 or an Oracle read replica. The default is open-read-only. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
OptionGroupMemberships (list) --
The list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
StatusInfos (list) --
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
Status (string) --
The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
The storage type associated with the DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Indicates whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name (FQDN) of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for the DB instance or cluster.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
DnsIps (list) --
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
(string) --
CopyTagsToSnapshot (boolean) --
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
DatabaseInsightsMode (string) --
The mode of Database Insights that is enabled for the instance.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB instance.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
EnabledCloudwatchLogsExports (list) --
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.
(string) --
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DeletionProtection (boolean) --
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Status (string) --
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (dict) --
The listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
ResumeFullAutomationModeTime (datetime) --
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.
CustomerOwnedIpEnabled (boolean) --
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A *CoIP *provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
NetworkType (string) --
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
DBSystemId (string) --
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
MasterUserSecret (dict) --
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
PercentProgress (string) --
The progress of the storage optimization operation as a percentage.
MultiTenant (boolean) --
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
IsStorageConfigUpgradeAvailable (boolean) --
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
EngineLifecycleSupport (string) --
The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains information about an additional storage volume for a DB instance.
VolumeName (string) --
The name of the additional storage volume.
StorageVolumeStatus (string) --
The status of the additional storage volume.
Valid Values: ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
StorageVolumeStatus (string) --
The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state.
{'BackupRetentionPeriod': 'integer', 'PreferredBackupWindow': 'string'}
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
See also: AWS API Documentation
Request Syntax
client.restore_db_instance_to_point_in_time(
SourceDBInstanceIdentifier='string',
TargetDBInstanceIdentifier='string',
RestoreTime=datetime(2015, 1, 1),
UseLatestRestorableTime=True|False,
DBInstanceClass='string',
Port=123,
AvailabilityZone='string',
DBSubnetGroupName='string',
MultiAZ=True|False,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
DBName='string',
Engine='string',
Iops=123,
StorageThroughput=123,
OptionGroupName='string',
CopyTagsToSnapshot=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
VpcSecurityGroupIds=[
'string',
],
Domain='string',
DomainIAMRoleName='string',
DomainFqdn='string',
DomainOu='string',
DomainAuthSecretArn='string',
DomainDnsIps=[
'string',
],
EnableIAMDatabaseAuthentication=True|False,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DBParameterGroupName='string',
DeletionProtection=True|False,
SourceDbiResourceId='string',
MaxAllocatedStorage=123,
EnableCustomerOwnedIp=True|False,
NetworkType='string',
SourceDBInstanceAutomatedBackupsArn='string',
BackupTarget='string',
CustomIamInstanceProfile='string',
AllocatedStorage=123,
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
DedicatedLogVolume=True|False,
CACertificateIdentifier='string',
EngineLifecycleSupport='string',
AdditionalStorageVolumes=[
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string'
)
string
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
string
[REQUIRED]
The name of the new DB instance to create.
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.
datetime
The date and time to restore from.
Constraints:
Must be a time in Universal Coordinated Time (UTC) format.
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
Specifies 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
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 DB instance class as the original DB instance.
integer
The port number on which the database accepts connections.
Default: The same port as the original DB instance.
Constraints:
The value must be 1150-65535.
string
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraints:
You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
string
The DB subnet group name to use for the new instance.
Constraints:
If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
boolean
Secifies whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraints:
You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
boolean
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
boolean
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
string
The license model information for the restored DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for Db2 - bring-your-own-license | marketplace-license
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
Default: Same as the source.
string
The database name for the restored DB instance.
This parameter doesn't apply to the following DB instances:
RDS Custom
RDS for Db2
RDS for MariaDB
RDS for MySQL
string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Valid Values:
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Default: The same as source
Constraints:
Must be compatible with the engine of the source.
integer
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
This setting doesn't apply to SQL Server.
Constraints:
Must be an integer greater than 1000.
integer
The storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
The name of the option group to use 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
Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
list
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
string
The storage type to associate with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
Default: io1, if the Iops parameter is specified. Otherwise, gp3.
Constraints:
If you specify io1, io2, or gp3, you must also include a value for the Iops parameter.
string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
list
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) --
string
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
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
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
Can't be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
string
The Active Directory organizational unit for your DB instance to join.
Constraints:
Must be in the distinguished name format.
Can't be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
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
list
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) --
boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
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.
list
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.
(string) --
list
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.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
string
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DB 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.
boolean
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
string
The resource ID of the source DB instance from which to restore.
integer
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
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
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
string
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
string
The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
local (Dedicated Local Zone)
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
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.
integer
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
This setting isn't valid for RDS for SQL Server.
integer
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
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
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.
boolean
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
string
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
string
The life cycle type for this DB instance.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
list
A list of additional storage volumes to restore to the DB instance. You can restore up to three additional storage volumes using the names rdsdbdata2, rdsdbdata3, and rdsdbdata4. Additional storage volumes are supported for RDS for Oracle and RDS for SQL Server DB instances only.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) -- [REQUIRED]
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
list
Tags to assign to resources associated with the DB instance.
Valid Values:
auto-backup - The DB instance's automated backup.
(dict) --
The tags to apply to resources when creating or modifying a DB instance or DB cluster. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Valid Values:
auto-backup - The DB instance's automated backup.
cluster-auto-backup - The DB cluster's automated backup.
Tags (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager in the restored DB instance.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Applies to RDS for Oracle only.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'UpgradeRolloutOrder': 'first'|'second'|'last',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'MultiTenant': True|False,
'IAMDatabaseAuthenticationEnabled': True|False,
'DedicatedLogVolume': True|False,
'Engine': 'string',
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string',
'OU': 'string',
'AuthSecretArn': 'string',
'DnsIps': [
'string',
]
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'DatabaseInsightsMode': 'standard'|'advanced',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomerOwnedIpEnabled': True|False,
'NetworkType': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AwsBackupRecoveryPointArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'ReadReplicaSourceDBClusterIdentifier': 'string',
'PercentProgress': 'string',
'MultiTenant': True|False,
'DedicatedLogVolume': True|False,
'IsStorageConfigUpgradeAvailable': True|False,
'EngineLifecycleSupport': 'string',
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'StorageVolumeStatus': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
],
'StorageVolumeStatus': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstanceIdentifier (string) --
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
Engine (string) --
The database engine used for this DB instance.
DBInstanceStatus (string) --
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
Endpoint (dict) --
The connection endpoint for the DB instance.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
The amount of storage in gibibytes (GiB) allocated for the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
DBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active.
DBParameterGroups (list) --
The list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
DBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates. Valid values are:
applying: The parameter group change is being applied to the database.
failed-to-apply: The parameter group is in an invalid state.
in-sync: The parameter group change is synchronized with the database.
pending-database-upgrade: The parameter group change will be applied after the DB instance is upgraded.
pending-reboot: The parameter group change will be applied after the DB instance reboots.
AvailabilityZone (string) --
The name of the Availability Zone where the DB instance is located.
DBSubnetGroup (dict) --
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
The status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
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) --
PreferredMaintenanceWindow (string) --
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
UpgradeRolloutOrder (string) --
This data type represents the order in which the instances are upgraded.
[first] - Typically used for development or testing environments.
[second] - Default order for resources not specifically configured.
[last] - Usually reserved for production environments.
PendingModifiedValues (dict) --
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
StorageThroughput (integer) --
The storage throughput of the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string) --
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
ResumeFullAutomationModeTime (datetime) --
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.
MultiTenant (boolean) --
Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
Engine (string) --
The database engine of the DB instance.
AdditionalStorageVolumes (list) --
The additional storage volume modifications that are pending for the DB instance.
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
LatestRestorableTime (datetime) --
The latest time to which a database in this DB instance can be restored with point-in-time restore.
MultiAZ (boolean) --
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
EngineVersion (string) --
The version of the database engine.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
ReadReplicaSourceDBInstanceIdentifier (string) --
The identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
The identifiers of the read replicas associated with this DB instance.
(string) --
ReadReplicaDBClusterIdentifiers (list) --
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.
(string) --
ReplicaMode (string) --
The open mode of a Db2 or an Oracle read replica. The default is open-read-only. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
OptionGroupMemberships (list) --
The list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
StatusInfos (list) --
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
Status (string) --
The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
The storage type associated with the DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Indicates whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name (FQDN) of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for the DB instance or cluster.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.
DnsIps (list) --
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
(string) --
CopyTagsToSnapshot (boolean) --
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
DatabaseInsightsMode (string) --
The mode of Database Insights that is enabled for the instance.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB instance.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
EnabledCloudwatchLogsExports (list) --
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.
(string) --
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle or SQL Server DB instance.
Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature.
DeletionProtection (boolean) --
Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Status (string) --
Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (dict) --
The listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
ResumeFullAutomationModeTime (datetime) --
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.
CustomerOwnedIpEnabled (boolean) --
Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A *CoIP *provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
NetworkType (string) --
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid Values: IPV4 | DUAL
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
DBSystemId (string) --
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
MasterUserSecret (dict) --
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
PercentProgress (string) --
The progress of the storage optimization operation as a percentage.
MultiTenant (boolean) --
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
IsStorageConfigUpgradeAvailable (boolean) --
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
EngineLifecycleSupport (string) --
The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the DB instance. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
(dict) --
Contains information about an additional storage volume for a DB instance.
VolumeName (string) --
The name of the additional storage volume.
StorageVolumeStatus (string) --
The status of the additional storage volume.
Valid Values: ACTIVE | CREATING | DELETING | MODIFYING | NOT-IN-USE | STORAGE-OPTIMIZATION | VOLUME-FULL
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
StorageVolumeStatus (string) --
The detailed status information for storage volumes associated with the DB instance. This information helps identify which specific volume is causing the instance to be in a storage-full state.
{'DBInstanceAutomatedBackup': {'PreferredBackupWindow': 'string'}}
Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.start_db_instance_automated_backups_replication(
SourceDBInstanceArn='string',
BackupRetentionPeriod=123,
KmsKeyId='string',
PreSignedUrl='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
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
The retention period for the replicated automated backups.
string
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
string
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.
list
A list of tags to associate with the replicated automated backups.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'MultiTenant': True|False,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
}
}
Response Structure
(dict) --
DBInstanceAutomatedBackup (dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
The earliest and latest time a DB instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
The allocated storage size for the automated backup in gibibytes (GiB).
Status (string) --
A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
VpcId (string) --
The VPC ID associated with the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
MasterUsername (string) --
The master user name of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
The license model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
StorageThroughput (integer) --
The storage throughput for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Indicates whether the automated backup is encrypted.
StorageType (string) --
The storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
MultiTenant (boolean) --
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the automated backup.
Valid Values: GP3 | IO2
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2
{'DBInstanceAutomatedBackup': {'PreferredBackupWindow': 'string'}}
Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
client.stop_db_instance_automated_backups_replication(
SourceDBInstanceArn='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'StorageThroughput': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'PreferredBackupWindow': 'string',
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string',
'MultiTenant': True|False,
'AwsBackupRecoveryPointArn': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DedicatedLogVolume': True|False,
'AdditionalStorageVolumes': [
{
'VolumeName': 'string',
'AllocatedStorage': 123,
'IOPS': 123,
'MaxAllocatedStorage': 123,
'StorageThroughput': 123,
'StorageType': 'string'
},
]
}
}
Response Structure
(dict) --
DBInstanceAutomatedBackup (dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
RestoreWindow (dict) --
The earliest and latest time a DB instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
The allocated storage size for the automated backup in gibibytes (GiB).
Status (string) --
A list of status information for an automated backup:
active - Automated backups for current instances.
retained - Automated backups for deleted instances.
creating - Automated backups that are waiting for the first automated snapshot to be available.
Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
VpcId (string) --
The VPC ID associated with the DB instance.
InstanceCreateTime (datetime) --
The date and time when the DB instance was created.
MasterUsername (string) --
The master user name of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
The license model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
StorageThroughput (integer) --
The storage throughput for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Indicates whether the automated backup is encrypted.
StorageType (string) --
The storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
PreferredBackupWindow (string) --
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
MultiTenant (boolean) --
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
TagList (list) --
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DedicatedLogVolume (boolean) --
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
AdditionalStorageVolumes (list) --
The additional storage volumes associated with the automated backup.
Valid Values: GP3 | IO2
(dict) --
Contains details about an additional storage volume for a DB instance. RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.
VolumeName (string) --
The name of the additional storage volume.
Valid Values: RDSDBDATA2 | RDSDBDATA3 | RDSDBDATA4
AllocatedStorage (integer) --
The amount of storage allocated for the additional storage volume, in gibibytes (GiB). The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).
IOPS (integer) --
The number of I/O operations per second (IOPS) provisioned for the additional storage volume.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.
StorageThroughput (integer) --
The storage throughput value for the additional storage volume, in mebibytes per second (MiBps). This setting applies only to the General Purpose SSD ( gp3) storage type.
StorageType (string) --
The storage type for the additional storage volume.
Valid Values: GP3 | IO2