RDS / Client / create_db_instance_read_replica

create_db_instance_read_replica#

RDS.Client.create_db_instance_read_replica(**kwargs)#

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 Db2, MariaDB, MySQL, 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. To create a DB instance for an Aurora DB cluster, use the CreateDBInstance operation.

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.

Request Syntax

response = 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',
    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',
    DedicatedLogVolume=True|False,
    UpgradeStorageConfig=True|False,
    CACertificateIdentifier='string',
    SourceRegion='string'
)

Parameters:

DBInstanceIdentifier (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.
SourceDBInstanceIdentifier (string) –
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 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 Db2, MariaDB, MySQL, 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.
DBInstanceClass (string) –
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all 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 the value from the source DB instance.
AvailabilityZone (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
Port (integer) –
The port number that the DB instance uses for connections.

Valid Values: 1150-65535

Default: Inherits the value from the source DB instance.
MultiAZ (boolean) –
Specifies 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 DB instances.
AutoMinorVersionUpgrade (boolean) –
Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window.

This setting doesn’t apply to RDS Custom DB instances.

Default: Inherits the value from the source DB instance.
Iops (integer) – The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.
OptionGroupName (string) –
The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster.

Note
For SQL Server, you must use the option group associated with the source.

This setting doesn’t apply to RDS Custom DB instances.
DBParameterGroupName (string) –
The name of the DB parameter group to associate with this DB instance.

If you don’t specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of the 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 DB instances for cross-Region read replicas and for Oracle DB instances. It isn’t supported for MySQL DB instances for same Region read replicas or 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.
PubliclyAccessible (boolean) –
Specifies whether the DB instance is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.

When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.
Tags (list) –
A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- (dict) –
  
  Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
  
  For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
  - Key (string) –
    
    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
  - Value (string) –
    
    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
DBSubnetGroupName (string) –
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 DB subnet group.
- 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
VpcSecurityGroupIds (list) –
A list of Amazon EC2 VPC security groups to associate with the read replica.

This setting doesn’t apply to RDS Custom DB instances.

Default: The default EC2 VPC security group for the DB subnet group’s VPC.
- (string) –
StorageType (string) –
The storage type to associate with the read replica.

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

Valid Values: gp2 | gp3 | io1 | io2 | standard

Default: io1 if the Iops parameter is specified. Otherwise, gp2.
CopyTagsToSnapshot (boolean) – Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren’t copied.
MonitoringInterval (integer) –
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 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
MonitoringRoleArn (string) –
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

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

This setting doesn’t apply to RDS Custom DB instances.
KmsKeyId (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.
PreSignedUrl (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 DB instances.

Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
EnableIAMDatabaseAuthentication (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 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.
EnablePerformanceInsights (boolean) –
Specifies 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 DB instances.
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.

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 DB instances.
PerformanceInsightsRetentionPeriod (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.
EnableCloudwatchLogsExports (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 DB instances.
- (string) –
ProcessorFeatures (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 for a DB instance class in RDS for Oracle 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.
UseDefaultProcessorFeatures (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.
DeletionProtection (boolean) – Specifies whether to enable deletion protection for the DB instance. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. For more information, see Deleting a DB Instance.
Domain (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 DB instances.
DomainIAMRoleName (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.
DomainFqdn (string) –
The fully qualified domain name (FQDN) of an Active Directory domain.

Constraints:
- Can’t be longer than 64 characters.
Example: mymanagedADtest.mymanagedAD.mydomain
DomainOu (string) –
The Active Directory organizational unit for your DB instance to join.

Constraints:
- Must be in the distinguished name format.
- Can’t be longer than 64 characters.
Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
DomainAuthSecretArn (string) –
The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
DomainDnsIps (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) –
ReplicaMode (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.
MaxAllocatedStorage (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.
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.

This setting is required for RDS Custom DB instances.
NetworkType (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.
StorageThroughput (integer) –
Specifies the storage throughput value for the read replica.

This setting doesn’t apply to RDS Custom or Amazon Aurora DB instances.
EnableCustomerOwnedIp (boolean) –
Specifies 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.
AllocatedStorage (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.
SourceDBClusterIdentifier (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.
DedicatedLogVolume (boolean) – Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
UpgradeStorageConfig (boolean) – Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout.
CACertificateIdentifier (string) –
The CA certificate identifier to use for the read replica’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.
SourceRegion (string) – The ID of the region that contains the source for the read replica.

Return type:

dict

Returns:

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',
            'DedicatedLogVolume': True|False,
            'MultiTenant': True|False
        },
        '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',
        'PercentProgress': 'string',
        'DedicatedLogVolume': True|False,
        'IsStorageConfigUpgradeAvailable': True|False,
        'MultiTenant': True|False,
        'EngineLifecycleSupport': '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 initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
  - Endpoint (dict) –
    
    The connection endpoint for the DB instance.
    
    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) –
      
      Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
    - EngineVersion (string) –
      
      The database engine version.
    - LicenseModel (string) –
      
      The license model for the DB instance.
      
      Valid values: license-included | bring-your-own-license | general-public-license
    - Iops (integer) –
      
      The Provisioned IOPS value for the DB instance.
    - 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 for a DB instance class in RDS for Oracle 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.
    - IAMDatabaseAuthenticationEnabled (boolean) –
      
      Indicates 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.
    - DedicatedLogVolume (boolean) –
      
      Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
    - MultiTenant (boolean) –
      
      Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
  - 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 Amazon Aurora or 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 instance is publicly accessible and you connect from outside of the DB instance’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
    
    When the DB instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
    
    For more information, see CreateDBInstance.
  - StatusInfos (list) –
    
    The status of a read replica. If the DB instance isn’t a read replica, the value is blank.
    - (dict) –
      
      Provides a list of status information for a DB instance.
      - StatusType (string) –
        
        This value is currently “read replication.”
      - Normal (boolean) –
        
        Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
      - Status (string) –
        
        The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
      - Message (string) –
        
        Details of the error if there is an error for the instance. If the instance isn’t in an error state, this value is blank.
  - StorageType (string) –
    
    The storage type associated with the DB instance.
  - TdeCredentialArn (string) –
    
    The ARN from the key store with which the instance is associated for TDE encryption.
  - DbInstancePort (integer) –
    
    The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
  - DBClusterIdentifier (string) –
    
    If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
  - StorageEncrypted (boolean) –
    
    Indicates whether the DB instance is encrypted.
  - KmsKeyId (string) –
    
    If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  - DbiResourceId (string) –
    
    The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) –
    
    The identifier of the CA certificate for this DB instance.
    
    For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
  - DomainMemberships (list) –
    
    The Active Directory Domain membership records associated with the DB instance.
    - (dict) –
      
      An Active Directory Domain membership record associated with the DB instance or cluster.
      - Domain (string) –
        
        The identifier of the Active Directory Domain.
      - Status (string) –
        
        The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
      - FQDN (string) –
        
        The fully qualified domain name (FQDN) of the Active Directory Domain.
      - IAMRoleName (string) –
        
        The name of the IAM role used when making API calls to the Directory Service.
      - OU (string) –
        
        The Active Directory organizational unit for the DB instance or cluster.
      - AuthSecretArn (string) –
        
        The ARN for the Secrets Manager secret with the credentials for the user that’s a member of the domain.
      - DnsIps (list) –
        
        The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
        
        (string) –
  - CopyTagsToSnapshot (boolean) –
    
    Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
    
    This setting doesn’t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
  - MonitoringInterval (integer) –
    
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
  - EnhancedMonitoringResourceArn (string) –
    
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
  - MonitoringRoleArn (string) –
    
    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  - PromotionTier (integer) –
    
    The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
  - DBInstanceArn (string) –
    
    The Amazon Resource Name (ARN) for the DB instance.
  - Timezone (string) –
    
    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
  - IAMDatabaseAuthenticationEnabled (boolean) –
    
    Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
    
    For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
  - 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 for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.
      - Name (string) –
        
        The name of the processor feature. Valid names are coreCount and threadsPerCore.
      - Value (string) –
        
        The value of a processor feature.
  - DeletionProtection (boolean) –
    
    Indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
  - AssociatedRoles (list) –
    
    The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
    - (dict) –
      
      Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
      - RoleArn (string) –
        
        The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
      - FeatureName (string) –
        
        The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
      - Status (string) –
        
        Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
        
        ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
        
        PENDING - the IAM role ARN is being associated with the DB instance.
        
        INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
  - ListenerEndpoint (dict) –
    
    The listener connection endpoint for SQL Server Always On.
    - Address (string) –
      
      Specifies the DNS address of the DB instance.
    - Port (integer) –
      
      Specifies the port that the database engine is listening on.
    - HostedZoneId (string) –
      
      Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - MaxAllocatedStorage (integer) –
    
    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
  - TagList (list) –
    
    A list of tags.
    
    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
    - (dict) –
      
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
      
      For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
      - Key (string) –
        
        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
      - Value (string) –
        
        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
  - 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.
  - PercentProgress (string) –
    
    The progress of the storage optimization operation as a percentage.
  - DedicatedLogVolume (boolean) –
    
    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
  - IsStorageConfigUpgradeAvailable (boolean) –
    
    Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
  - MultiTenant (boolean) –
    
    Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
  - EngineLifecycleSupport (string) –
    
    The life cycle type for the DB instance.
    
    For more information, see CreateDBInstance.

Exceptions

RDS.Client.exceptions.DBInstanceAlreadyExistsFault
RDS.Client.exceptions.InsufficientDBInstanceCapacityFault
RDS.Client.exceptions.DBParameterGroupNotFoundFault
RDS.Client.exceptions.DBSecurityGroupNotFoundFault
RDS.Client.exceptions.InstanceQuotaExceededFault
RDS.Client.exceptions.StorageQuotaExceededFault
RDS.Client.exceptions.DBInstanceNotFoundFault
RDS.Client.exceptions.DBClusterNotFoundFault
RDS.Client.exceptions.InvalidDBInstanceStateFault
RDS.Client.exceptions.InvalidDBClusterStateFault
RDS.Client.exceptions.DBSubnetGroupNotFoundFault
RDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs
RDS.Client.exceptions.InvalidSubnet
RDS.Client.exceptions.InvalidVPCNetworkStateFault
RDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFault
RDS.Client.exceptions.OptionGroupNotFoundFault
RDS.Client.exceptions.DBSubnetGroupNotAllowedFault
RDS.Client.exceptions.InvalidDBSubnetGroupFault
RDS.Client.exceptions.StorageTypeNotSupportedFault
RDS.Client.exceptions.KMSKeyNotAccessibleFault
RDS.Client.exceptions.DomainNotFoundFault
RDS.Client.exceptions.NetworkTypeNotSupported
RDS.Client.exceptions.TenantDatabaseQuotaExceededFault
RDS.Client.exceptions.CertificateNotFoundFault

Examples

This example creates a DB instance read replica.

response = client.create_db_instance_read_replica(
    AvailabilityZone='us-east-1a',
    CopyTagsToSnapshot=True,
    DBInstanceClass='db.t2.micro',
    DBInstanceIdentifier='mydbreadreplica',
    PubliclyAccessible=True,
    SourceDBInstanceIdentifier='mymysqlinstance',
    StorageType='gp2',
    Tags=[
        {
            'Key': 'mydbreadreplicakey',
            'Value': 'mydbreadreplicavalue',
        },
    ],
)

print(response)

Expected Output:

{
    'DBInstance': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}