RDS / Client / create_db_instance

create_db_instance#

RDS.Client.create_db_instance(**kwargs)#

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

response = 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',
    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'
)

Parameters:

DBName (string) –
The meaning of this parameter differs according to the database engine you use.

MySQL

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

Constraints:
- Must contain 1 to 64 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can’t be a word reserved by the specified database engine
MariaDB

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

Constraints:
- Must contain 1 to 64 letters or numbers.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can’t be a word reserved by the specified database engine
PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn’t specified, a database named postgres is created in the DB instance.

Constraints:
- Must contain 1 to 63 letters, numbers, or underscores.
- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
- Can’t be a word reserved by the specified database engine
Oracle

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

Default: ORCL

Constraints:
- Can’t be longer than 8 characters
Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don’t specify a value, the default value is ORCL.

Default: ORCL

Constraints:
- It must contain 1 to 8 alphanumeric characters.
- It must contain a letter.
- It can’t be a word reserved by the database engine.
Amazon RDS Custom for SQL Server

Not applicable. Must be null.

SQL Server

Not applicable. Must be null.

Amazon Aurora MySQL

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn’t specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.

Constraints:
- It must contain 1 to 64 alphanumeric characters.
- It can’t be a word reserved by the database engine.
Amazon Aurora PostgreSQL

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn’t specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.

Constraints:
- It must contain 1 to 63 alphanumeric characters.
- It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
- It can’t be a word reserved by the database engine.
DBInstanceIdentifier (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
AllocatedStorage (integer) –
The amount of storage in gibibytes (GiB) to allocate for the DB instance.

Type: Integer

Amazon Aurora

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

Amazon RDS Custom

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

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

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

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

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.
SQL Server

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.
DBInstanceClass (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.
Engine (string) –
[REQUIRED]

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

Not every database engine is available for every Amazon Web Services Region.

Valid Values:
- aurora (for MySQL 5.6-compatible Aurora)
- aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
- aurora-postgresql
- 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
MasterUsername (string) –
The name for the master user.

Amazon Aurora

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

Amazon RDS

Constraints:
- Required.
- 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.
MasterUserPassword (string) –
The password for the master user. The password can include any printable ASCII character except “/”, “””, or “@”.

Amazon Aurora

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

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.
DBSecurityGroups (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) –
VpcSecurityGroupIds (list) –
A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

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

Default: The default EC2 VPC security group for the DB subnet group’s VPC.
- (string) –
AvailabilityZone (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.

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.

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.
DBSubnetGroupName (string) –
A DB subnet group to associate with this DB instance.

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

Example: mydbsubnetgroup
PreferredMaintenanceWindow (string) –
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

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

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

Constraints: Minimum 30-minute window.
DBParameterGroupName (string) –
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

This setting doesn’t apply to RDS Custom.

Constraints:
- It must be 1 to 255 letters, numbers, or hyphens.
- The first character must be a letter.
- It can’t end with a hyphen or contain two consecutive hyphens.
BackupRetentionPeriod (integer) –
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

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

Default: 1

Constraints:
- Must be a value from 0 to 35
- Can’t be set to 0 if the DB instance is a source to read replicas
- Can’t be set to 0 for an RDS Custom for Oracle DB instance
PreferredBackupWindow (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.

Amazon Aurora

Not applicable. 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.
Port (integer) –
The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer
MultiAZ (boolean) –
A value that indicates 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 RDS Custom.

Amazon Aurora

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
EngineVersion (string) –
The version number of the database engine to use.

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 Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

Amazon RDS Custom for Oracle

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.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

MariaDB

For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
AutoMinorVersionUpgrade (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 applied automatically.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
LicenseModel (string) –
License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

This setting doesn’t apply to RDS Custom.

Amazon Aurora

Not applicable.
Iops (integer) –
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.
OptionGroupName (string) –
A value that indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can’t be removed from an option group. 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 RDS Custom.

Amazon Aurora

Not applicable.
CharacterSetName (string) –
For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.

This setting doesn’t apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
NcharCharacterSetName (string) –
The name of the NCHAR character set for the Oracle DB instance.

This parameter doesn’t apply to RDS Custom.
PubliclyAccessible (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.

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.
Tags (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}_.:/=+\-@]*)$”).
DBClusterIdentifier (string) –
The identifier of the DB cluster that the instance will belong to.

This setting doesn’t apply to RDS Custom.
StorageType (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

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.
TdeCredentialArn (string) –
The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn’t apply to RDS Custom.

Amazon Aurora

Not applicable.
TdeCredentialPassword (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.
StorageEncrypted (boolean) –
A value that indicates whether the DB instance is encrypted. By default, it isn’t encrypted.

For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.
KmsKeyId (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.

Amazon Aurora

Not applicable. 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.

Amazon RDS Custom

A KMS key is required for RDS Custom 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.
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.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.
CopyTagsToSnapshot (boolean) –
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
MonitoringInterval (integer) –
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable 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.

Valid Values: 0, 1, 5, 10, 15, 30, 60
MonitoringRoleArn (string) –
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, 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.
DomainIAMRoleName (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.

Amazon Aurora

Not applicable. The domain is managed by 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.

This setting doesn’t apply to RDS Custom.

Default: 1

Valid Values: 0 - 15
Timezone (string) – The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
EnableIAMDatabaseAuthentication (boolean) –
A value that indicates whether to enable mapping of 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 RDS Custom.

Amazon Aurora

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
EnablePerformanceInsights (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.

This setting doesn’t apply to RDS Custom.
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.
PerformanceInsightsRetentionPeriod (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.
EnableCloudwatchLogsExports (list) –
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

RDS Custom

Not applicable.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, trace, and oemagent.

PostgreSQL

Possible values are postgresql and upgrade.
- (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.

Amazon Aurora

Not applicable.
- (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) –
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.

Amazon Aurora

Not applicable. 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.
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.

This setting doesn’t apply to RDS Custom.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.
EnableCustomerOwnedIp (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.

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.
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.
BackupTarget (string) –
Specifies where automated backups and manual snapshots are stored.

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.
NetworkType (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.
StorageThroughput (integer) –
Specifies the storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn’t apply to RDS Custom or Amazon Aurora.
ManageMasterUserPassword (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.
MasterUserSecretKmsKeyId (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.
CACertificateIdentifier (string) –
Specifies the CA certificate identifier to use for the DB instance’s server certificate.

This setting doesn’t apply to RDS Custom.

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.

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
        },
        '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'
            },
        ],
        '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) –
    
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
  - DBInstanceClass (string) –
    
    Contains the name of the compute and memory capacity class of the DB instance.
  - Engine (string) –
    
    The name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) –
    
    Specifies 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) –
    
    Contains the master username for the DB instance.
  - DBName (string) –
    
    The meaning of this parameter differs according to the database engine you use.
    
    MySQL, MariaDB, SQL Server, PostgreSQL
    
    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
    
    Type: String
    
    Oracle
    
    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
  - Endpoint (dict) –
    
    Specifies the connection endpoint.
    
    Note
    
    The endpoint might not be shown for instances whose status is 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) –
    
    Specifies the allocated storage size specified in gibibytes (GiB).
  - InstanceCreateTime (datetime) –
    
    Provides the date and time the DB instance was created.
  - PreferredBackupWindow (string) –
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - BackupRetentionPeriod (integer) –
    
    Specifies the number of days for which automatic DB snapshots are retained.
  - DBSecurityGroups (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) –
    
    Provides a list of VPC security group elements 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) –
    
    Provides 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) –
    
    Specifies the name of the Availability Zone the DB instance is located in.
  - DBSubnetGroup (dict) –
    
    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
    - DBSubnetGroupName (string) –
      
      The name of the DB subnet group.
    - DBSubnetGroupDescription (string) –
      
      Provides the description of the DB subnet group.
    - VpcId (string) –
      
      Provides the VpcId of the DB subnet group.
    - SubnetGroupStatus (string) –
      
      Provides the status of the DB subnet group.
    - Subnets (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) –
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) –
    
    A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
    - DBInstanceClass (string) –
      
      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.
  - LatestRestorableTime (datetime) –
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - MultiAZ (boolean) –
    
    Specifies if the DB instance is a Multi-AZ deployment. This setting doesn’t apply to RDS Custom.
  - EngineVersion (string) –
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) –
    
    A value that indicates that minor version patches are applied automatically.
  - ReadReplicaSourceDBInstanceIdentifier (string) –
    
    Contains the identifier of the source DB instance if this DB instance is a read replica.
  - ReadReplicaDBInstanceIdentifiers (list) –
    
    Contains one or more identifiers of the read replicas associated with this DB instance.
    - (string) –
  - ReadReplicaDBClusterIdentifiers (list) –
    
    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS 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) –
    
    License model information for this DB instance. This setting doesn’t apply to RDS Custom.
  - Iops (integer) –
    
    Specifies the Provisioned IOPS (I/O operations per second) value.
  - OptionGroupMemberships (list) –
    
    Provides 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) –
    
    Specifies the accessibility options for the DB instance.
    
    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 instance isn’t a read replica, this 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) –
    
    Specifies 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) –
    
    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
  - DBClusterIdentifier (string) –
    
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
  - StorageEncrypted (boolean) –
    
    Specifies whether the DB instance is encrypted.
  - KmsKeyId (string) –
    
    If StorageEncrypted is true, the 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 of the Active Directory Domain.
      - IAMRoleName (string) –
        
        The name of the IAM role to be used when making API calls to the Directory Service.
  - CopyTagsToSnapshot (boolean) –
    
    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
    
    Amazon Aurora
    
    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
  - MonitoringInterval (integer) –
    
    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
  - EnhancedMonitoringResourceArn (string) –
    
    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
  - MonitoringRoleArn (string) –
    
    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  - PromotionTier (integer) –
    
    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
  - DBInstanceArn (string) –
    
    The Amazon Resource Name (ARN) for the DB instance.
  - Timezone (string) –
    
    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
  - IAMDatabaseAuthenticationEnabled (boolean) –
    
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    
    IAM database authentication can be enabled for the following database engines
    - For MySQL 5.6, minor version 5.6.34 or higher
    - For MySQL 5.7, minor version 5.7.16 or higher
    - Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
  - PerformanceInsightsEnabled (boolean) –
    
    True if Performance Insights is enabled for the DB instance, and otherwise false.
  - 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. 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
  - 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 Amazon RDS Database 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 if 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) –
    
    Specifies 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) –
    
    Specifies 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) –
    
    Specifies 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.
    
    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 and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
  - ActivityStreamPolicyStatus (string) –
    
    The status of the policy state of the activity stream.
  - StorageThroughput (integer) –
    
    Specifies 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 valid for RDS Custom only.
  - MasterUserSecret (dict) –
    
    Contains 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) –
    
    Contains the identifier of the source DB cluster if this DB instance is a read replica.

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.DBSubnetGroupNotFoundFault
RDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs
RDS.Client.exceptions.InvalidDBClusterStateFault
RDS.Client.exceptions.InvalidSubnet
RDS.Client.exceptions.InvalidVPCNetworkStateFault
RDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFault
RDS.Client.exceptions.OptionGroupNotFoundFault
RDS.Client.exceptions.DBClusterNotFoundFault
RDS.Client.exceptions.StorageTypeNotSupportedFault
RDS.Client.exceptions.AuthorizationNotFoundFault
RDS.Client.exceptions.KMSKeyNotAccessibleFault
RDS.Client.exceptions.DomainNotFoundFault
RDS.Client.exceptions.BackupPolicyNotFoundFault
RDS.Client.exceptions.NetworkTypeNotSupported
RDS.Client.exceptions.CertificateNotFoundFault

Examples

This example creates a DB instance.

response = client.create_db_instance(
    AllocatedStorage=5,
    DBInstanceClass='db.t2.micro',
    DBInstanceIdentifier='mymysqlinstance',
    Engine='MySQL',
    MasterUserPassword='MyPassword',
    MasterUsername='MyUser',
)

print(response)

Expected Output:

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