2023/06/28 - Amazon Relational Database Service - 25 updated api methods
Changes Amazon Relational Database Service (RDS) now supports joining a RDS for SQL Server instance to a self-managed Active Directory.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about 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(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
CharacterSetName='string',
DatabaseName='string',
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
ReplicationSourceIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
PreSignedUrl='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
EngineMode='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DeletionProtection=True|False,
GlobalClusterIdentifier='string',
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
EnableGlobalWriteForwarding=True|False,
DBClusterInstanceClass='string',
AllocatedStorage=123,
StorageType='string',
Iops=123,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
NetworkType='string',
DBSystemId='string',
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
SourceRegion='string'
)
list
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
(string) --
integer
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
string
The name of the character set (CharacterSet ) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
string
The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
[REQUIRED]
The identifier for this DB cluster. This parameter is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
string
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
list
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
(string) --
string
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default .
Example: mydbsubnetgroup
string
[REQUIRED]
The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
string
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide .
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
integer
The port number on which the instances in the DB cluster accept connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
string
The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
string
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.
string
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
string
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide .
Constraints:
Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
string
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide .
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi .
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun .
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
string
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
list
Tags to assign to the DB cluster.
Valid for Cluster Type: 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.
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 the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId :
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1 .
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters only
Note
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
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 .
Valid for Cluster Type: Aurora DB clusters only
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0 .
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
list
The list of log types that need to be enabled for exporting to CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
(string) --
string
The DB engine mode of the DB cluster, either provisioned or serverless .
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :
Valid for Cluster Type: Aurora DB clusters only
dict
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: 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) --
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
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.
boolean
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
boolean
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
boolean
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
string
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
boolean
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
string
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
string
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
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 Provisioned IOPS storage in the Amazon RDS User Guide .
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
boolean
Specifies whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Valid for Cluster Type: Multi-AZ DB clusters only
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
boolean
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0 .
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
boolean
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
Valid for Cluster Type: Multi-AZ DB clusters only
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
string
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
string
Reserved for future use.
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
The ID of the region that contains the source for the read replica.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DomainAuthSecretArn': 'string',
'DomainDnsIps': ['string'],
'DomainFqdn': 'string',
'DomainOu': 'string'}
Response {'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
client.create_db_instance(
DBName='string',
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
Engine='string',
MasterUsername='string',
MasterUserPassword='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
DBSubnetGroupName='string',
PreferredMaintenanceWindow='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
Port=123,
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
CharacterSetName='string',
NcharCharacterSetName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBClusterIdentifier='string',
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
StorageEncrypted=True|False,
KmsKeyId='string',
Domain='string',
DomainFqdn='string',
DomainOu='string',
DomainAuthSecretArn='string',
DomainDnsIps=[
'string',
],
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
DomainIAMRoleName='string',
PromotionTier=123,
Timezone='string',
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
DeletionProtection=True|False,
MaxAllocatedStorage=123,
EnableCustomerOwnedIp=True|False,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string',
StorageThroughput=123,
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
CACertificateIdentifier='string'
)
string
The meaning of this parameter differs depending on the database engine.
Amazon Aurora MySQL Amazon Aurora PostgreSQL Amazon RDS Custom for Oracle Amazon RDS Custom for SQL Server RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL Server
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster.
Constraints:
Must contain 1 to 64 alphanumeric characters.
Can't be a word reserved by the database engine.
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created.
Default: postgres
Constraints:
Must contain 1 to 63 alphanumeric characters.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
Can't be a word reserved by the database engine.
The Oracle System ID (SID) of the created RDS Custom DB instance.
Default: ORCL
Constraints:
Must contain 1 to 8 alphanumeric characters.
Must contain a letter.
Can't be a word reserved by the database engine.
Not applicable. Must be null.
The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the database engine.
The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the database engine.
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
Can't be longer than 8 characters.
Can't be a word reserved by the database engine, such as the string NULL .
The name of the database to create when the DB instance is created.
Default: postgres
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the database engine.
Not applicable. Must be null.
string
[REQUIRED]
The identifier for this DB instance. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
integer
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Amazon RDS Custom RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2, gp3):
Enterprise and Standard editions: Must be an integer from 20 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 100 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 20 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
string
[REQUIRED]
The compute and memory capacity of the DB instance, for example db.m5.large . Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .
string
[REQUIRED]
The database engine to use for this DB instance.
Not every database engine is available in every Amazon Web Services Region.
Valid Values:
aurora-mysql (for Aurora MySQL DB instances)
aurora-postgresql (for Aurora PostgreSQL DB instances)
custom-oracle-ee (for RDS Custom for Oracle DB instances)
custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
string
The name for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.
This setting is required for RDS DB instances.
Constraints:
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
string
The password for the master user.
This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.
Constraints:
Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@".
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
list
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
(string) --
list
A list of Amazon EC2 VPC security groups to associate with this DB instance.
This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
(string) --
string
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Constraints:
The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
Example: us-east-1d
string
A DB subnet group to associate with this DB instance.
Constraints:
Must match the name of an existing DB subnet group.
Must not be default .
Example: mydbsubnetgroup
string
The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi .
The day values must be mon | tue | wed | thu | fri | sat | sun .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
string
The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
integer
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
Can't be set to 0 for an RDS Custom for Oracle DB instance.
string
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide .
This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
integer
The port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values: 1150-65535
Default:
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , or 49152-49156 .
boolean
Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to the following DB instances:
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
RDS Custom
string
The version number of the database engine to use.
This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon RDS Custom for Oracle Amazon RDS Custom for SQL Server RDS for MariaDB RDS for Microsoft SQL Server RDS for MySQL RDS for Oracle RDS for PostgreSQL
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.*customized_string* . A valid CEV name is 19.my_cev1 . For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide .
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide .
For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide .
For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide .
For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide .
For information, see Oracle Database Engine release notes in the Amazon RDS User Guide .
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide .
boolean
Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false .
string
The license model information for this DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
integer
The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide .
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Constraints:
For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
string
The option group to associate the DB instance with.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
string
For supported engines, the character set (CharacterSet ) to associate the DB instance with.
This setting doesn't apply to the following DB instances:
Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster .
RDS Custom - However, if you need to change the character set, you can change it on the database itself.
string
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
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.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.
list
Tags to assign to the DB instance.
(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.
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 identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
string
The storage type to associate with the DB instance.
If you specify io1 or gp3 , you must also include a value for the Iops parameter.
This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
Valid Values: gp2 | gp3 | io1 | standard
Default: io1 , if the Iops parameter is specified. Otherwise, gp2 .
string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
boolean
Specifes whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.
This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
string
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster .
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted , the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.
string
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
string
Specifies the fully qualified domain name of an Active Directory domain.
Constraints:
Cannot be greater 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.
Cannot be greater than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
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
Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0 .
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0 .
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0 , then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
string
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The domain is managed by the DB cluster.)
RDS Custom
integer
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
string
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server .
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 for MySQL and PostgreSQL in the Amazon RDS User Guide .
This setting doesn't apply to the following DB instances:
Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)
RDS Custom
boolean
Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
integer
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.
list
The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
This setting doesn't apply to the following DB instances:
Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)
RDS Custom
The following values are valid for each DB engine:
RDS for MariaDB - audit | error | general | slowquery
RDS for Microsoft SQL Server - agent | error
RDS for MySQL - audit | error | general | slowquery
RDS for Oracle - alert | audit | listener | trace | oemagent
RDS for PostgreSQL - postgresql | upgrade
(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 Amazon Aurora or RDS Custom DB instances.
(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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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 .
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
integer
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to the following DB instances:
Amazon Aurora (Storage is managed by the DB cluster.)
RDS Custom
boolean
Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
string
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
This setting is required for RDS Custom.
Constraints:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
string
The location for storing automated backups and manual snapshots.
Valie Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
string
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
integer
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
string
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 .
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DomainAuthSecretArn': 'string',
'DomainDnsIps': ['string'],
'DomainFqdn': 'string',
'DomainOu': 'string'}
Response {'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide .
Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified.
Warning
Your source DB instance or cluster must have backup retention enabled.
See also: AWS API Documentation
Request Syntax
client.create_db_instance_read_replica(
DBInstanceIdentifier='string',
SourceDBInstanceIdentifier='string',
DBInstanceClass='string',
AvailabilityZone='string',
Port=123,
MultiAZ=True|False,
AutoMinorVersionUpgrade=True|False,
Iops=123,
OptionGroupName='string',
DBParameterGroupName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBSubnetGroupName='string',
VpcSecurityGroupIds=[
'string',
],
StorageType='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
KmsKeyId='string',
PreSignedUrl='string',
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
Domain='string',
DomainIAMRoleName='string',
DomainFqdn='string',
DomainOu='string',
DomainAuthSecretArn='string',
DomainDnsIps=[
'string',
],
ReplicaMode='open-read-only'|'mounted',
MaxAllocatedStorage=123,
CustomIamInstanceProfile='string',
NetworkType='string',
StorageThroughput=123,
EnableCustomerOwnedIp=True|False,
AllocatedStorage=123,
SourceDBClusterIdentifier='string',
SourceRegion='string'
)
string
[REQUIRED]
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
string
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide .
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide .
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide . This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
string
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide .
Default: Inherits from the source DB instance.
string
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
integer
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
boolean
A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
boolean
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits from the source DB instance
integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
string
The option group the DB instance is associated with. If omitted, the option group associated with the source instance or cluster is used.
Note
For SQL Server, you must use the option group associated with the source.
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 Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
boolean
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
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 a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.
All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>
Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created outside of any VPC.
Example: mydbsubnetgroup
list
A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
(string) --
string
Specifies the storage type to be associated with the read replica.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
boolean
A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
string
The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
string
When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
This setting applies only when replicating from a source DB instance . Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115 .
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
Note
If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
boolean
A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
integer
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
list
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
(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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
boolean
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
string
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
string
The name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
string
Specifies the fully qualified domain name of an Active Directory domain.
Constraints:
Cannot be greater 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.
Cannot be greater than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
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) --
string
The open mode of the replica database: mounted or read-only.
Note
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
For RDS Custom, you must specify this parameter and set it to mounted . The value won't be set by default. After replica creation, you can manage the open mode manually.
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 .
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.
string
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
integer
Specifies the storage throughput value for the read replica.
This setting doesn't apply to RDS Custom or Amazon Aurora.
boolean
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
integer
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance .
Note
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
string
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
Must be the identifier of an existing Multi-AZ DB cluster.
Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported.
string
The ID of the region that contains the source for the read replica.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.
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(
DBClusterIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string'
)
string
[REQUIRED]
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
boolean
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
Note
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
string
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Note
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed , incompatible-restore , or incompatible-network , you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance(
DBInstanceIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string',
DeleteAutomatedBackups=True|False
)
string
[REQUIRED]
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match the name of an existing DB instance.
boolean
A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
Note
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed , incompatible-restore , or incompatible-network , RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
string
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
Note
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
Must be 1 to 255 letters or numbers.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Can't be specified when deleting a read replica.
boolean
A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBClusters': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API 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 .
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
See also: AWS API Documentation
Request Syntax
client.describe_db_clusters(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False
)
string
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DB cluster identifier.
list
A filter that specifies one or more DB clusters to describe.
Supported Filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
(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.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
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 DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
boolean
Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
dict
Response Syntax
{
'Marker': 'string',
'DBClusters': [
{
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusters action.
Marker (string) --
A pagination token that can be used in a later DescribeDBClusters request.
DBClusters (list) --
Contains a list of DB clusters for the user.
(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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBInstances': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Describes provisioned RDS instances. This API supports pagination.
Note
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
See also: AWS API Documentation
Request Syntax
client.describe_db_instances(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DB instance.
list
A filter that specifies one or more DB instances to describe.
Supported Filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
(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.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
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 DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstances 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 .
DBInstances (list) --
A list of DBInstance instances.
(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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora 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.failover_db_cluster(
DBClusterIdentifier='string',
TargetDBInstanceIdentifier='string'
)
string
[REQUIRED]
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
string
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1 .
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
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.modify_db_cluster(
DBClusterIdentifier='string',
NewDBClusterIdentifier='string',
ApplyImmediately=True|False,
BackupRetentionPeriod=123,
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Port=123,
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
DBInstanceParameterGroupName='string',
Domain='string',
DomainIAMRoleName='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DeletionProtection=True|False,
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False,
EnableGlobalWriteForwarding=True|False,
DBClusterInstanceClass='string',
AllocatedStorage=123,
StorageType='string',
Iops=123,
AutoMinorVersionUpgrade=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
NetworkType='string',
ManageMasterUserPassword=True|False,
RotateMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
EngineMode='string',
AllowEngineModeChange=True|False
)
string
[REQUIRED]
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
string
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
boolean
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
integer
The number of days for which automated backups are retained. Specify a minimum value of 1 .
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
string
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
list
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
(string) --
integer
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
string
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.
string
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
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 weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide .
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi .
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun .
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
boolean
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0 .
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
dict
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
EnableLogTypes (list) --
The list of log types to enable.
(string) --
DisableLogTypes (list) --
The list of log types to disable.
(string) --
string
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
string
The name of the DB parameter group to apply to all instances of the DB cluster.
Note
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
string
The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
string
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
dict
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
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.
boolean
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
Valid for Cluster Type: Aurora DB clusters only
boolean
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
string
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide .
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
string
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide .
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
boolean
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0 .
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
string
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
boolean
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
Valid for Cluster Type: Multi-AZ DB clusters only
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
integer
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
string
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword .
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword . In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword .
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
boolean
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
string
The DB engine mode of the DB cluster, either provisioned or serverless .
Note
The DB engine mode can be modified only from serverless to provisioned .
For more information, see CreateDBCluster .
Valid for Cluster Type: Aurora DB clusters only
boolean
Specifies whether engine mode changes from serverless to provisioned are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DisableDomain': 'boolean',
'DomainAuthSecretArn': 'string',
'DomainDnsIps': ['string'],
'DomainFqdn': 'string',
'DomainOu': 'string'}
Response {'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance .
See also: AWS API Documentation
Request Syntax
client.modify_db_instance(
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
DBSubnetGroupName='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
ApplyImmediately=True|False,
MasterUserPassword='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
NewDBInstanceIdentifier='string',
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
CACertificateIdentifier='string',
Domain='string',
DomainFqdn='string',
DomainOu='string',
DomainAuthSecretArn='string',
DomainDnsIps=[
'string',
],
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
DBPortNumber=123,
PubliclyAccessible=True|False,
MonitoringRoleArn='string',
DomainIAMRoleName='string',
DisableDomain=True|False,
PromotionTier=123,
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
MaxAllocatedStorage=123,
CertificateRotationRestart=True|False,
ReplicaMode='open-read-only'|'mounted',
EnableCustomerOwnedIp=True|False,
AwsBackupRecoveryPointArn='string',
AutomationMode='full'|'all-paused',
ResumeFullAutomationModeMinutes=123,
NetworkType='string',
StorageThroughput=123,
ManageMasterUserPassword=True|False,
RotateMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
Engine='string'
)
string
[REQUIRED]
The identifier of DB instance to modify. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DB instance.
integer
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance .
string
The new compute and memory capacity of the DB instance, for example db.m4.large . Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide . For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server .
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
string
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide .
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately .
This parameter doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB subnet group.
Example: mydbsubnetgroup
list
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
If supplied, must match existing DB security groups.
(string) --
list
A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster .)
RDS Custom
Constraints:
If supplied, must match existing VPC security group IDs.
(string) --
boolean
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance , or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
string
The new password for the master user.
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
Note
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
This setting doesn't apply to the following DB instances:
Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster .)
RDS Custom
Default: Uses existing setting
Constraints:
Can't be specified if ManageMasterUserPassword is turned on.
Can include any printable ASCII character except "/", """, or "@".
Length Constraints:
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
string
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom DB instances.
Default: Uses existing setting
Constraints:
Must be in the same DB parameter group family as the DB instance.
integer
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Note
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
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.
string
The weekly time range during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter causes a reboot of the DB instance. If you change this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi .
The day values must be mon | tue | wed | thu | fri | sat | sun .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
boolean
Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom DB instances.
string
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance , or call DescribeDBEngineVersions .
If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
boolean
Specifies whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that's a different major version than the DB instance's current version.
boolean
Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
The automatic upgrade is enabled for the maintenance window.
A newer minor version is available.
RDS has enabled automatic patching for the engine version.
If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
string
The license model for the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Valid Values:
RDS for MariaDB - general-public-license
RDS for Microsoft SQL Server - license-included
RDS for MySQL - general-public-license
RDS for Oracle - bring-your-own-license | license-included
RDS for PostgreSQL - postgresql-license
integer
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints:
For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
string
The option group to associate the DB instance with.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom DB instances.
string
The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately , or will occur during the next maintenance window if you disable ApplyImmediately . This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom DB instances.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
string
The storage type to associate with the DB instance.
If you specify Provisioned IOPS (io1 ), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid Values: gp2 | gp3 | io1 | standard
Default: io1 , if the Iops parameter is specified. Otherwise, gp2 .
string
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom DB instances.
string
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom DB instances.
string
The CA certificate identifier to use for the DB instance6'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 Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
string
Specifies the fully qualified domain name of an Active Directory domain.
Constraints:
Cannot be greater 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.
Cannot be greater than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
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 DB instance to snapshots of the DB instance. By default, tags aren't copied.
This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster .
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0 .
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0 .
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
integer
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom DB instances.
Valid Values: 1150-65535
Default:
Amazon Aurora - 3306
RDS for MariaDB - 3306
RDS for Microsoft SQL Server - 1433
RDS for MySQL - 3306
RDS for Oracle - 1521
RDS for PostgreSQL - 5432
Constraints:
For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , or 49152-49156 .
boolean
Specifies whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom DB instances.
string
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
Boolean. If present, removes the instance from the Active Directory domain.
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 .
This setting doesn't apply to RDS Custom DB instances.
Default: 1
Valid Values: 0 - 15
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 Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom DB instances.
boolean
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom DB instances.
integer
The number of days to retain Performance Insights data.
This setting doesn't apply to RDS Custom DB instances.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.
dict
The log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom DB instances.
EnableLogTypes (list) --
The list of log types to enable.
(string) --
DisableLogTypes (list) --
The list of log types to disable.
(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 DB instances.
(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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
boolean
Specifies whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom DB instances.
boolean
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
integer
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
boolean
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Warning
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
This setting doesn't apply to RDS Custom DB instances.
string
A value that sets the open mode of a replica database to either mounted or read-only.
Note
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom DB instances.
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.
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 Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
string
The automation mode of the RDS Custom DB instance. If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes .
integer
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
Default: 60
Constraints:
Must be at least 60.
Must be no more than 1,440.
string
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values: IPV4 | DUAL
integer
The storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword .
If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword . In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword .
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
boolean
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
You must apply the change immediately when rotating the master user password.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
string
The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb or oracle-se2-cdb .
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a new option group with --option-group-name .
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Promotes a read replica DB instance to a standalone DB instance.
Note
Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
See also: AWS API Documentation
Request Syntax
client.promote_read_replica(
DBInstanceIdentifier='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string'
)
string
[REQUIRED]
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing read replica DB instance.
Example: mydbinstance
integer
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
Must be a value from 0 to 35.
Can't be set to 0 if the DB instance is a source to read replicas.
string
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Promotes a read replica DB cluster to a standalone DB cluster.
See also: AWS API Documentation
Request Syntax
client.promote_read_replica_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
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.reboot_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBCluster.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
See also: AWS API Documentation
Request Syntax
client.reboot_db_instance(
DBInstanceIdentifier='string',
ForceFailover=True|False
)
string
[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
boolean
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide .
Note
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
See also: AWS API Documentation
Request Syntax
client.restore_db_cluster_from_s3(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
CharacterSetName='string',
DatabaseName='string',
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
SourceEngine='string',
SourceEngineVersion='string',
S3BucketName='string',
S3Prefix='string',
S3IngestionRoleArn='string',
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
NetworkType='string',
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
StorageType='string'
)
list
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
(string) --
integer
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
string
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
string
The database name for the restored DB cluster.
string
[REQUIRED]
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
string
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
list
A list of EC2 VPC security groups to associate with the restored DB cluster.
(string) --
string
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
string
[REQUIRED]
The name of the database engine to be used for this DB cluster.
Valid Values: aurora-mysql (for Aurora MySQL)
string
The version number of the database engine to use.
To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
Examples: 5.7.mysql_aurora.2.07.1 , 8.0.mysql_aurora.3.02.0
integer
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
string
[REQUIRED]
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
string
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
string
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
string
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide .
Constraints:
Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide .
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
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
A value that indicates whether the restored DB cluster is encrypted.
string
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
string
[REQUIRED]
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
string
[REQUIRED]
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40 , 5.7.28
string
[REQUIRED]
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
string
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Note
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
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.
Aurora MySQL
Possible values are audit , error , general , and slowquery .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
(string) --
boolean
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
boolean
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
string
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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.
boolean
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
string
Specifies the storage type to be associated with the DB cluster.
Valid values: aurora , aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': '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.
Note
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.
For more information on Amazon Aurora 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,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
NetworkType='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.
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
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Note
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
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 , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(string) --
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) --
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
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
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
string
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
Valid for: Aurora DB clusters only
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
string
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
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': '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.
Note
For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
For more information on Amazon Aurora 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',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
EngineMode='string',
DBClusterInstanceClass='string',
StorageType='string',
PubliclyAccessible=True|False,
Iops=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
NetworkType='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
[REQUIRED]
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
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
integer
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.
(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.
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
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
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 , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
(string) --
string
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
boolean
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
string
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
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) --
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause (integer) --
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
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.
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
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Multi-AZ DB clusters only
integer
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
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DomainAuthSecretArn': 'string',
'DomainDnsIps': ['string'],
'DomainFqdn': 'string',
'DomainOu': 'string'}
Response {'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': '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 action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
Note
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot .
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,
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,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string',
StorageThroughput=123,
DBClusterSnapshotIdentifier='string',
AllocatedStorage=123
)
string
[REQUIRED]
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 DBSnapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
string
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 DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
boolean
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
boolean
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
boolean
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
string
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
string
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
integer
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
string
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.
(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.
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 | standard
If you specify io1 or gp3 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
string
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
Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
string
Specifies the fully qualified domain name of an Active Directory domain.
Constraints:
Cannot be greater 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.
Cannot be greater than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
Constraints:
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
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide .
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
string
The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName , then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
boolean
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
boolean
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
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.
string
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region .
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
string
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
integer
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
string
The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.
integer
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Note
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
client.restore_db_instance_from_s3(
DBName='string',
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
Engine='string',
MasterUsername='string',
MasterUserPassword='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
DBSubnetGroupName='string',
PreferredMaintenanceWindow='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
Port=123,
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
StorageEncrypted=True|False,
KmsKeyId='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnableIAMDatabaseAuthentication=True|False,
SourceEngine='string',
SourceEngineVersion='string',
S3BucketName='string',
S3Prefix='string',
S3IngestionRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
MaxAllocatedStorage=123,
NetworkType='string',
StorageThroughput=123,
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string'
)
string
The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance .
string
[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
integer
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance .
Note
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
string
[REQUIRED]
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
string
[REQUIRED]
The name of the database engine to be used for this instance.
Valid Values: mysql
string
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
string
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
list
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
(string) --
list
A list of VPC security groups to associate with this DB instance.
(string) --
string
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
string
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
string
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi .
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
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.
integer
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance .
string
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi .
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
integer
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150 -65535
Default: 3306
boolean
A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
string
The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance , or call DescribeDBEngineVersions .
boolean
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
string
The license model for this DB instance. Use general-public-license .
integer
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
string
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
boolean
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
list
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
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 | standard
If you specify io1 or gp3 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
boolean
A value that indicates whether the new DB instance is encrypted or not.
string
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
boolean
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
string
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
string
[REQUIRED]
The name of the engine of your source database.
Valid Values: mysql
string
[REQUIRED]
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
string
[REQUIRED]
The name of your Amazon S3 bucket that contains your database backup file.
string
The prefix of your Amazon S3 bucket.
string
[REQUIRED]
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
boolean
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
string
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
integer
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
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 .
(string) --
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
boolean
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
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 .
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.
integer
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
boolean
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
string
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',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DomainAuthSecretArn': 'string',
'DomainDnsIps': ['string'],
'DomainFqdn': 'string',
'DomainOu': 'string'}
Response {'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': '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.
Note
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime .
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,
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,
SourceDBInstanceAutomatedBackupsArn='string',
EnableCustomerOwnedIp=True|False,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string',
StorageThroughput=123,
AllocatedStorage=123
)
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 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
datetime
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
boolean
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
string
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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
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 DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
boolean
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
boolean
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
boolean
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
string
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
string
The database name for the restored DB instance.
Note
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
string
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
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.
boolean
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
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 | standard
If you specify io1 or gp3 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
string
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
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
string
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
string
Specifies the fully qualified domain name of an Active Directory domain.
Constraints:
Cannot be greater 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.
Cannot be greater than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
string
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
Constraints:
Cannot be greater 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
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
string
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName , then the default DBParameterGroup for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
boolean
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection 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.
string
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
This setting doesn't apply to RDS Custom.
boolean
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
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.
string
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region .
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
string
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
integer
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
integer
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance .
Note
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
client.start_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
Note
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
See also: AWS API Documentation
Request Syntax
client.start_db_instance(
DBInstanceIdentifier='string'
)
string
[REQUIRED]
The user-supplied instance identifier.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBCluster': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
client.stop_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'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,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'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'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string',
'BackupRetentionPeriod': 123,
'AllocatedStorage': 123,
'Iops': 123,
'StorageType': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'NetworkType': 'string',
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1)
}
}
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) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (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.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
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).
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) --
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) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (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.
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 .
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) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
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.
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 for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) --
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
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) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
BackupRetentionPeriod (integer) --
The number of days for which automatic DB snapshots are retained.
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.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type for the DB cluster.
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.
PubliclyAccessible (boolean) --
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora 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 non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
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. 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 40, 40.5, 41, and so on. The largest value that you can use is 128.
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
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.
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.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
Note
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
See also: AWS API Documentation
Request Syntax
client.stop_db_instance(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string'
)
string
[REQUIRED]
The user-supplied instance identifier.
string
The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.
{'DBInstance': {'DomainMemberships': {'AuthSecretArn': 'string',
'DnsIps': ['string'],
'OU': 'string'}}}
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the Region that hosts the current standby database.
See also: AWS API Documentation
Request Syntax
client.switchover_read_replica(
DBInstanceIdentifier='string'
)
string
[REQUIRED]
The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Oracle read replica DB instance.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'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',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'StorageThroughput': 123,
'Engine': '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,
'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,
'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'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
'StorageThroughput': 123,
'DBSystemId': 'string',
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'ReadReplicaSourceDBClusterIdentifier': '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.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
The master username for the DB instance.
DBName (string) --
The meaning of this parameter differs depending on the database engine.
For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance.
For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
Endpoint (dict) --
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of creating .
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
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.
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.
(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).
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) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
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.
StorageThroughput (integer) --
The storage throughput of the DB instance.
Engine (string) --
The database engine of the DB instance.
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.
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.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
(string) --
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value for the DB instance.
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 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 .
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) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
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 to be used when making API calls to the Directory Service.
OU (string) --
The Active Directory organizational unit for your DB instance to join.
AuthSecretArn (string) --
The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
DnsIps (list) --
The IPv4 DNS IP addresses of your 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 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 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 .
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 DB instance.
Your Oracle 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 of the DB Instance Class 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 name.
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) --
Describes 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) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (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.
(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.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (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.
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 .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
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.
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.
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 .
BackupTarget (string) --
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
StorageThroughput (integer) --
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
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.
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.
ReadReplicaSourceDBClusterIdentifier (string) --
The identifier of the source DB cluster if this DB instance is a read replica.