AWS API Changes

2016/08/04 - Amazon Relational Database Service - 1 new 9 updated api methods

Changes You can now use the AWS Management Console to easily move your DB instance to a different VPC, or to a different subnet group in the same VPC. For more information, see Updating the VPC for a DB Instance. If your DB instance is not in a VPC, you can now use the AWS Management Console to easily move your DB instance into a VPC. You can now copy the source files from a MySQL database to an Amazon Simple Storage Service (Amazon S3) bucket, and then restore an Amazon Aurora DB cluster from those files. This option can be considerably faster than migrating data using mysqldump.

RestoreDBClusterFromS3 (new)

Link ¶

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from an External MySQL Database to an Amazon Aurora DB Cluster .

Request Syntax

client.restore_db_cluster_from_s3(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    DatabaseName='string',
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    SourceEngine='string',
    SourceEngineVersion='string',
    S3BucketName='string',
    S3Prefix='string',
    S3IngestionRoleArn='string'
)

type AvailabilityZones

list

param AvailabilityZones

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

(string) --

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

type CharacterSetName

string

param CharacterSetName

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

type DatabaseName

string

param DatabaseName

The database name for the restored DB cluster.

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the restored DB cluster.

(string) --

type DBSubnetGroupName

string

param DBSubnetGroupName

A DB subnet group to associate with the restored DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

type Engine

string

param Engine

[REQUIRED]

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

Aurora

Example: 5.6.10a

type Port

integer

param Port

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

type MasterUsername

string

param MasterUsername

[REQUIRED]

The name of the master user for the restored DB cluster.

Constraints:

Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

type MasterUserPassword

string

param MasterUserPassword

[REQUIRED]

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

type OptionGroupName

string

param OptionGroupName

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi .
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

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

Constraints: Minimum 30-minute window.

type Tags

list

param Tags

A list of tags.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 cannot 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 cannot 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}_.:/=+\-]*)$").

type StorageEncrypted

boolean

param StorageEncrypted

Specifies whether the restored DB cluster is encrypted.

type KmsKeyId

string

param KmsKeyId

The KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

type SourceEngine

string

param SourceEngine

[REQUIRED]

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

type SourceEngineVersion

string

param SourceEngineVersion

[REQUIRED]

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

type S3BucketName

string

param S3BucketName

[REQUIRED]

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

type S3Prefix

string

param S3Prefix

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

type S3IngestionRoleArn

string

param S3IngestionRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

rtype

dict

returns

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        'PercentProgress': 'string',
        'EarliestRestorableTime': datetime(2015, 1, 1),
        'Endpoint': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'LatestRestorableTime': datetime(2015, 1, 1),
        'Port': 123,
        'MasterUsername': 'string',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'ReplicationSourceIdentifier': 'string',
        'ReadReplicaIdentifiers': [
            'string',
        ],
        'DBClusterMembers': [
            {
                'DBInstanceIdentifier': 'string',
                'IsClusterWriter': True|False,
                'DBClusterParameterGroupStatus': 'string',
                'PromotionTier': 123
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'HostedZoneId': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbClusterResourceId': 'string'
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gigabytes (GB).
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies the number of days for which automatic DB snapshots are retained.
  - CharacterSetName (string) --
    
    If present, specifies the name of the character set that this cluster is associated with.
  - DatabaseName (string) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies the progress of the operation as a percentage.
  - EarliestRestorableTime (datetime) --
    
    Specifies the earliest time to which a database can be restored with point-in-time restore.
  - Endpoint (string) --
    
    Specifies the connection endpoint for the primary instance of the DB cluster.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides the list of option group memberships for this DB cluster.
    - (dict) --
      
      Contains status information for a DB cluster option group.
      - DBClusterOptionGroupName (string) --
        
        Specifies the name of the DB cluster option group.
      - Status (string) --
        
        Specifies the status of the DB cluster option group.
  - PreferredBackupWindow (string) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
  - ReadReplicaIdentifiers (list) --
    
    Contains one or more identifiers of the Read Replicas associated with this DB cluster.
    - (string) --
  - DBClusterMembers (list) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - DBClusterParameterGroupStatus (string) --
        
        Specifies the status of the DB cluster parameter group for this member of the DB cluster.
      - PromotionTier (integer) --
        
        A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster .
  - VpcSecurityGroups (list) --
    
    Provides a list of VPC security groups that the DB cluster belongs to.
    - (dict) --
      
      This data type is used as a response element for queries on VPC security group membership.
      - VpcSecurityGroupId (string) --
        
        The name of the VPC security group.
      - Status (string) --
        
        The status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

CreateDBInstance (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Creates a new DB instance.

Request Syntax

client.create_db_instance(
    DBName='string',
    DBInstanceIdentifier='string',
    AllocatedStorage=123,
    DBInstanceClass='string',
    Engine='string',
    MasterUsername='string',
    MasterUserPassword='string',
    DBSecurityGroups=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    AvailabilityZone='string',
    DBSubnetGroupName='string',
    PreferredMaintenanceWindow='string',
    DBParameterGroupName='string',
    BackupRetentionPeriod=123,
    PreferredBackupWindow='string',
    Port=123,
    MultiAZ=True|False,
    EngineVersion='string',
    AutoMinorVersionUpgrade=True|False,
    LicenseModel='string',
    Iops=123,
    OptionGroupName='string',
    CharacterSetName='string',
    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
)

type DBName

string

param DBName

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

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

Constraints:

Must contain 1 to 64 alphanumeric characters
Cannot 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 is not specified, no database is created in the DB instance.

Constraints:

Must contain 1 to 64 alphanumeric characters
Cannot 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 is not specified, the default "postgres" database is created in the DB instance.

Constraints:

Must contain 1 to 63 alphanumeric characters
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

Cannot be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

Must contain 1 to 64 alphanumeric characters
Cannot be a word reserved by the specified database engine

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

type AllocatedStorage

integer

param AllocatedStorage

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

MySQL

Constraints: Must be an integer from 5 to 6144.

MariaDB

Constraints: Must be an integer from 5 to 6144.

PostgreSQL

Constraints: Must be an integer from 5 to 6144.

Oracle

Constraints: Must be an integer from 10 to 6144.

SQL Server

Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

type DBInstanceClass

string

param DBInstanceClass

[REQUIRED]

The compute and memory capacity of the DB instance.

type Engine

string

param Engine

[REQUIRED]

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

Not every database engine is available for every AWS region.

type MasterUsername

string

param MasterUsername

The name of master user for the client DB instance.

MySQL

Constraints:

Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

MariaDB

Constraints:

Must be 1 to 16 alphanumeric characters.
Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

Must be 1 to 30 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

SQL Server

Constraints:

Must be 1 to 128 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

PostgreSQL

Constraints:

Must be 1 to 63 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

type MasterUserPassword

string

param MasterUserPassword

The password for the master database user. Can be any printable ASCII character except "/", """, or "@".

Type: String

MySQL

Constraints: Must contain from 8 to 41 characters.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

SQL Server

Constraints: Must contain from 8 to 128 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon Aurora

Constraints: Must contain from 8 to 41 characters.

type DBSecurityGroups

list

param DBSecurityGroups

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

(string) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

(string) --

type AvailabilityZone

string

param AvailabilityZone

The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones .

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true . The specified Availability Zone must be in the same region as the current endpoint.

type DBSubnetGroupName

string

param DBSubnetGroupName

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance .

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

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

Constraints: Minimum 30-minute window.

type DBParameterGroupName

string

param DBParameterGroupName

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups .

Constraints:

Must be in the format hh24:mi-hh24:mi .
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

type Port

integer

param Port

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 for 1434 , 3389 , 47001 , 49152 , and 49152 through 49156 .

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

type MultiAZ

boolean

param MultiAZ

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

Amazon Aurora

Version 5.6 (only available in AWS regions ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1, us-west-2): 5.6.10a

MariaDB

Version 10.1 (available in all AWS regions except us-gov-west-1): 10.1.14
Version 10.0 (available in all AWS regions): 10.0.17 | 10.0.24

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1

Microsoft SQL Server Express Edition (sqlserver-ex)

Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1

Microsoft SQL Server Standard Edition (sqlserver-se)

Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1

Microsoft SQL Server Web Edition (sqlserver-web)

Version 12.00 (available in all AWS regions): 12.00.4422.0.v1
Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1
Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1

MySQL

Version 5.7 (available in all AWS regions): 5.7.10 | 5.7.11
Version 5.6 (available in all AWS regions except ap-south-1, ap-northeast-2): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22
Version 5.6 (available in all AWS regions except ap-south-1): 5.6.23
Version 5.6 (available in all AWS regions): 5.6.27 | 5.6.29
Version 5.5 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a
Version 5.5 (available in all AWS regions except ap-south-1, ap-northeast-2): 5.5.40b | 5.5.41
Version 5.5 (available in all AWS regions except ap-south-1): 5.5.42
Version 5.5 (available in all AWS regions): 5.5.46
Version 5.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b

Oracle Database Enterprise Edition (oracle-ee)

Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 12.1 (available in all AWS regions): 12.1.0.2.v1
Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition (oracle-se)

Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition One (oracle-se1)

Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2
Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3
Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4
Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition Two (oracle-se2)

Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4

PostgreSQL

Version 9.5 (available in all AWS regions except us-gov-west-1): 9.5.2
Version 9.4 (available in all AWS regions except ap-south-1): 9.4.1 | 9.4.4
Version 9.4 (available in all AWS regions): 9.4.5
Version 9.4 (available in all AWS regions except us-gov-west-1): 9.4.7
Version 9.3 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.1 | 9.3.2
Version 9.3 (available in all AWS regions except ap-south-1, ap-northeast-2): 9.3.10 | 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9
Version 9.3 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.3.12

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

type LicenseModel

string

param LicenseModel

License model information for this DB instance.

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

type Iops

integer

param Iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.

type OptionGroupName

string

param OptionGroupName

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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

type CharacterSetName

string

param CharacterSetName

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

type PubliclyAccessible

boolean

param PubliclyAccessible

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

Default VPC: true
VPC: false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

type Tags

list

param Tags

A list of tags.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 cannot 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 cannot 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}_.:/=+\-]*)$").

type DBClusterIdentifier

string

param DBClusterIdentifier

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster .

Type: String

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

type TdeCredentialArn

string

param TdeCredentialArn

The ARN from the Key Store with which to associate the instance for TDE encryption.

type TdeCredentialPassword

string

param TdeCredentialPassword

The password for the given ARN from the Key Store in order to access the device.

type StorageEncrypted

boolean

param StorageEncrypted

Specifies whether the DB instance is encrypted.

Default: false

type KmsKeyId

string

param KmsKeyId

The KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

type Domain

string

param Domain

Specify the Active Directory Domain to create the instance in.

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

type MonitoringInterval

integer

param MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

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

Valid Values: 0, 1, 5, 10, 15, 30, 60

type MonitoringRoleArn

string

param MonitoringRoleArn

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to 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 .

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

type DomainIAMRoleName

string

param DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

type PromotionTier

integer

param PromotionTier

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster .

Default: 1

Valid Values: 0 - 15

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

CreateDBInstanceReadReplica (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

Warning

The source DB instance must have backup retention enabled.

Request Syntax

client.create_db_instance_read_replica(
    DBInstanceIdentifier='string',
    SourceDBInstanceIdentifier='string',
    DBInstanceClass='string',
    AvailabilityZone='string',
    Port=123,
    AutoMinorVersionUpgrade=True|False,
    Iops=123,
    OptionGroupName='string',
    PubliclyAccessible=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DBSubnetGroupName='string',
    StorageType='string',
    CopyTagsToSnapshot=True|False,
    MonitoringInterval=123,
    MonitoringRoleArn='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

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

type SourceDBInstanceIdentifier

string

param SourceDBInstanceIdentifier

[REQUIRED]

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.
Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN) .

type DBInstanceClass

string

param DBInstanceClass

The compute and memory capacity of the Read Replica.

Default: Inherits from the source DB instance.

type AvailabilityZone

string

param AvailabilityZone

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

type Port

integer

param Port

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

type Iops

integer

param Iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

type OptionGroupName

string

param OptionGroupName

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

type PubliclyAccessible

boolean

param PubliclyAccessible

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

Default VPC: true
VPC: false

type Tags

list

param Tags

A list of tags.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 cannot 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 cannot 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}_.:/=+\-]*)$").

type DBSubnetGroupName

string

param DBSubnetGroupName

Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

Can only be specified if the source DB instance identifier specifies a DB instance in another region.
The specified DB subnet group must be in the same region in which the operation is running.
All Read Replicas in one region that are created from the same source DB instance must either:>
- Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
- Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

type StorageType

string

param StorageType

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

type MonitoringInterval

integer

param MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

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

Valid Values: 0, 1, 5, 10, 15, 30, 60

type MonitoringRoleArn

string

param MonitoringRoleArn

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

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

DeleteDBInstance (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed , incompatible-restore , or incompatible-network , you can only delete it when the SkipFinalSnapshot parameter is set to true .

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true:

The DB cluster is a Read Replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

Request Syntax

client.delete_db_instance(
    DBInstanceIdentifier='string',
    SkipFinalSnapshot=True|False,
    FinalDBSnapshotIdentifier='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type SkipFinalSnapshot

boolean

param SkipFinalSnapshot

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

Note

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false .

Default: false

type FinalDBSnapshotIdentifier

string

param FinalDBSnapshotIdentifier

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false .

Note

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Cannot be specified when deleting a Read Replica.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

DescribeDBInstances (updated)

Link ¶
Changes (response)

{'DBInstances': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Returns information about provisioned RDS instances. This API supports pagination.

Request Syntax

client.describe_db_instances(
    DBInstanceIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type Filters

list

param Filters

This parameter is not currently supported.

(dict) --

This type is not currently supported.
- Name (string) -- [REQUIRED]
  
  This parameter is not currently supported.
- Values (list) -- [REQUIRED]
  
  This parameter is not currently supported.
  - (string) --

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBInstances': [
        {
            'DBInstanceIdentifier': 'string',
            'DBInstanceClass': 'string',
            'Engine': 'string',
            'DBInstanceStatus': 'string',
            'MasterUsername': 'string',
            'DBName': 'string',
            'Endpoint': {
                'Address': 'string',
                'Port': 123,
                'HostedZoneId': 'string'
            },
            'AllocatedStorage': 123,
            'InstanceCreateTime': datetime(2015, 1, 1),
            'PreferredBackupWindow': 'string',
            'BackupRetentionPeriod': 123,
            'DBSecurityGroups': [
                {
                    'DBSecurityGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'VpcSecurityGroups': [
                {
                    'VpcSecurityGroupId': 'string',
                    'Status': 'string'
                },
            ],
            'DBParameterGroups': [
                {
                    'DBParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'DBSubnetGroup': {
                'DBSubnetGroupName': 'string',
                'DBSubnetGroupDescription': 'string',
                'VpcId': 'string',
                'SubnetGroupStatus': 'string',
                'Subnets': [
                    {
                        'SubnetIdentifier': 'string',
                        'SubnetAvailabilityZone': {
                            'Name': 'string'
                        },
                        'SubnetStatus': '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'
            },
            'LatestRestorableTime': datetime(2015, 1, 1),
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'ReadReplicaSourceDBInstanceIdentifier': 'string',
            'ReadReplicaDBInstanceIdentifiers': [
                'string',
            ],
            'LicenseModel': 'string',
            'Iops': 123,
            'OptionGroupMemberships': [
                {
                    'OptionGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'CharacterSetName': '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
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeDBInstances action.
- Marker (string) --
  
  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
- DBInstances (list) --
  
  A list of DBInstance instances.
  - (dict) --
    
    Contains the result of a successful invocation of the following actions:
    - CreateDBInstance
    - DeleteDBInstance
    - ModifyDBInstance
    This data type is used as a response element in the DescribeDBInstances action.
    - 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) --
      
      Provides the name of the database engine to be used for this DB instance.
    - DBInstanceStatus (string) --
      
      Specifies the current state of this database.
    - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
      
      MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
      
      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.
      - 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 gigabytes.
    - 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) --
      
      Provides List of DB security group elements containing only 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 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 status of the VPC security group.
    - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
    - PreferredMaintenanceWindow (string) --
      
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    - PendingModifiedValues (dict) --
      
      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) --
        
        Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
      - AllocatedStorage (integer) --
        
        Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
      - MasterUserPassword (string) --
        
        Contains the pending or in-progress change of the master credentials for the DB instance.
      - Port (integer) --
        
        Specifies the pending port for the DB instance.
      - BackupRetentionPeriod (integer) --
        
        Specifies the pending number of days for which automated backups are retained.
      - MultiAZ (boolean) --
        
        Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
      - EngineVersion (string) --
        
        Indicates 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) --
        
        Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
      - DBInstanceIdentifier (string) --
        
        Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
      - StorageType (string) --
        
        Specifies the storage type to be associated with the DB instance.
      - CACertificateIdentifier (string) --
        
        Specifies the identifier of the CA certificate for the DB instance.
      - DBSubnetGroupName (string) --
        
        The new DB subnet group for 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.
    - EngineVersion (string) --
      
      Indicates the database engine version.
    - AutoMinorVersionUpgrade (boolean) --
      
      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) --
    - LicenseModel (string) --
      
      License model information for this DB instance.
    - 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.
    - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
      
      Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
      - Default VPC: true
      - VPC: false
      If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
    - StatusInfos (list) --
      
      The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
        
        Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
    - StorageType (string) --
      
      Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
    - DbiResourceId (string) --
      
      The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
    - CACertificateIdentifier (string) --
      
      The identifier of the CA certificate for this DB instance.
    - 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.
        
        Domain (string) --
        
        The identifier of the Active Directory Domain.
        
        Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
        
        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.
    - 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 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 .

ModifyDBInstance (updated)

Link ¶
Changes (request, response)
Request

{'DBSubnetGroupName': 'string'}

Response

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Request Syntax

client.modify_db_instance(
    DBInstanceIdentifier='string',
    AllocatedStorage=123,
    DBInstanceClass='string',
    DBSubnetGroupName='string',
    DBSecurityGroups=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    ApplyImmediately=True|False,
    MasterUserPassword='string',
    DBParameterGroupName='string',
    BackupRetentionPeriod=123,
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    MultiAZ=True|False,
    EngineVersion='string',
    AllowMajorVersionUpgrade=True|False,
    AutoMinorVersionUpgrade=True|False,
    LicenseModel='string',
    Iops=123,
    OptionGroupName='string',
    NewDBInstanceIdentifier='string',
    StorageType='string',
    TdeCredentialArn='string',
    TdeCredentialPassword='string',
    CACertificateIdentifier='string',
    Domain='string',
    CopyTagsToSnapshot=True|False,
    MonitoringInterval=123,
    DBPortNumber=123,
    PubliclyAccessible=True|False,
    MonitoringRoleArn='string',
    DomainIAMRoleName='string',
    PromotionTier=123
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Must be the identifier for an existing DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type AllocatedStorage

integer

param AllocatedStorage

The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-6144

Type: Integer

MariaDB

Default: Uses existing setting

Valid Values: 5-6144

Type: Integer

PostgreSQL

Default: Uses existing setting

Valid Values: 5-6144

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-6144

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

type DBInstanceClass

string

param DBInstanceClass

The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

type DBSubnetGroupName

string

param DBSubnetGroupName

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC, or to a different subnet group in the same VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance .

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.

Example: mySubnetGroup

type DBSecurityGroups

list

param DBSecurityGroups

A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

(string) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

(string) --

type ApplyImmediately

boolean

param ApplyImmediately

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false , changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance , or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

Default: false

type MasterUserPassword

string

param MasterUserPassword

The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

Note

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

type DBParameterGroupName

string

param DBParameterGroupName

The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

Must be a value from 0 to 35
Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
Cannot be set to 0 if the DB instance is a source to Read Replicas

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

Must be in the format hh24:mi-hh24:mi
Times should be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

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

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

type MultiAZ

boolean

param MultiAZ

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB instance is a Read Replica.

type EngineVersion

string

param EngineVersion

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For a list of valid engine versions, see CreateDBInstance .

type AllowMajorVersionUpgrade

boolean

param AllowMajorVersionUpgrade

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

type LicenseModel

string

param LicenseModel

The license model for the DB instance.

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

type Iops

integer

param Iops

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Type: Integer

type OptionGroupName

string

param OptionGroupName

Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

type NewDBInstanceIdentifier

string

param NewDBInstanceIdentifier

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

type TdeCredentialArn

string

param TdeCredentialArn

The ARN from the Key Store with which to associate the instance for TDE encryption.

type TdeCredentialPassword

string

param TdeCredentialPassword

The password for the given ARN from the Key Store in order to access the device.

type CACertificateIdentifier

string

param CACertificateIdentifier

Indicates the certificate that needs to be associated with the instance.

type Domain

string

param Domain

Specify the Active Directory Domain to move the instance to.

The specified Active Directory Domain must be created prior to this operation. Currently only a SQL Server instance can be created in a Active Directory Domain.

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

type MonitoringInterval

integer

param MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

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

Valid Values: 0, 1, 5, 10, 15, 30, 60

type DBPortNumber

integer

param DBPortNumber

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

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 for 1434 , 3389 , 47001 , 49152 , and 49152 through 49156 .

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

type PubliclyAccessible

boolean

param PubliclyAccessible

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

type MonitoringRoleArn

string

param MonitoringRoleArn

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

type DomainIAMRoleName

string

param DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

type PromotionTier

integer

param PromotionTier

Default: 1

Valid Values: 0 - 15

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

PromoteReadReplica (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Promotes a Read Replica DB instance to a standalone DB instance.

Note

We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

Request Syntax

client.promote_read_replica(
    DBInstanceIdentifier='string',
    BackupRetentionPeriod=123,
    PreferredBackupWindow='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

Must be the identifier for an existing Read Replica DB instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: mydbinstance

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

Must be a value from 0 to 8

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Constraints:

Must be in the format hh24:mi-hh24:mi .
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

RebootDBInstance (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

Request Syntax

client.reboot_db_instance(
    DBInstanceIdentifier='string',
    ForceFailover=True|False
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type ForceFailover

boolean

param ForceFailover

When true , the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

RestoreDBInstanceFromDBSnapshot (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Request Syntax

client.restore_db_instance_from_db_snapshot(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string',
    DBInstanceClass='string',
    Port=123,
    AvailabilityZone='string',
    DBSubnetGroupName='string',
    MultiAZ=True|False,
    PubliclyAccessible=True|False,
    AutoMinorVersionUpgrade=True|False,
    LicenseModel='string',
    DBName='string',
    Engine='string',
    Iops=123,
    OptionGroupName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageType='string',
    TdeCredentialArn='string',
    TdeCredentialPassword='string',
    Domain='string',
    CopyTagsToSnapshot=True|False,
    DomainIAMRoleName='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

type DBSnapshotIdentifier

string

param DBSnapshotIdentifier

[REQUIRED]

The identifier for the DB snapshot to restore from.

Constraints:

Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

type DBInstanceClass

string

param DBInstanceClass

The compute and memory capacity of the Amazon RDS DB instance.

type Port

integer

param Port

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

type AvailabilityZone

string

param AvailabilityZone

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true .

Example: us-east-1a

type DBSubnetGroupName

string

param DBSubnetGroupName

The DB subnet group name to use for the new instance.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

type MultiAZ

boolean

param MultiAZ

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true .

type PubliclyAccessible

boolean

param PubliclyAccessible

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

Default VPC: true
VPC: false

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

type LicenseModel

string

param LicenseModel

License model information for the restored DB instance.

Default: Same as source.

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

type DBName

string

param DBName

The database name for the restored DB instance.

Note

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

type Engine

string

param Engine

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

type Iops

integer

param Iops

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

type OptionGroupName

string

param OptionGroupName

The name of the option group to be used for the restored DB instance.

type Tags

list

param Tags

A list of tags.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 cannot 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 cannot 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}_.:/=+\-]*)$").

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

type TdeCredentialArn

string

param TdeCredentialArn

The ARN from the Key Store with which to associate the instance for TDE encryption.

type TdeCredentialPassword

string

param TdeCredentialPassword

The password for the given ARN from the Key Store in order to access the device.

type Domain

string

param Domain

Specify the Active Directory Domain to restore the instance in.

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

type DomainIAMRoleName

string

param DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .

RestoreDBInstanceToPointInTime (updated)

Link ¶
Changes (response)

{'DBInstance': {'PendingModifiedValues': {'DBSubnetGroupName': 'string'}}}

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

Request Syntax

client.restore_db_instance_to_point_in_time(
    SourceDBInstanceIdentifier='string',
    TargetDBInstanceIdentifier='string',
    RestoreTime=datetime(2015, 1, 1),
    UseLatestRestorableTime=True|False,
    DBInstanceClass='string',
    Port=123,
    AvailabilityZone='string',
    DBSubnetGroupName='string',
    MultiAZ=True|False,
    PubliclyAccessible=True|False,
    AutoMinorVersionUpgrade=True|False,
    LicenseModel='string',
    DBName='string',
    Engine='string',
    Iops=123,
    OptionGroupName='string',
    CopyTagsToSnapshot=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageType='string',
    TdeCredentialArn='string',
    TdeCredentialPassword='string',
    Domain='string',
    DomainIAMRoleName='string'
)

type SourceDBInstanceIdentifier

string

param SourceDBInstanceIdentifier

[REQUIRED]

The identifier of the source DB instance from which to restore.

Constraints:

Must be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type TargetDBInstanceIdentifier

string

param TargetDBInstanceIdentifier

[REQUIRED]

The name of the new database instance to be created.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type RestoreTime

datetime

param RestoreTime

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

type UseLatestRestorableTime

boolean

param UseLatestRestorableTime

Specifies whether (true ) or not (false ) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

type DBInstanceClass

string

param DBInstanceClass

The compute and memory capacity of the Amazon RDS DB instance.

Default: The same DBInstanceClass as the original DB instance.

type Port

integer

param Port

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

type AvailabilityZone

string

param AvailabilityZone

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

type DBSubnetGroupName

string

param DBSubnetGroupName

The DB subnet group name to use for the new instance.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

type MultiAZ

boolean

param MultiAZ

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true .

type PubliclyAccessible

boolean

param PubliclyAccessible

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

Default VPC: true
VPC: false

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

type LicenseModel

string

param LicenseModel

License model information for the restored DB instance.

Default: Same as source.

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

type DBName

string

param DBName

The database name for the restored DB instance.

Note

This parameter is not used for the MySQL or MariaDB engines.

type Engine

string

param Engine

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

type Iops

integer

param Iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

type OptionGroupName

string

param OptionGroupName

The name of the option group to be used for the restored DB instance.

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

type Tags

list

param Tags

A list of tags.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 cannot 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 cannot 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}_.:/=+\-]*)$").

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

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

Default: io1 if the Iops parameter is specified; otherwise standard

type TdeCredentialArn

string

param TdeCredentialArn

The ARN from the Key Store with which to associate the instance for TDE encryption.

type TdeCredentialPassword

string

param TdeCredentialPassword

The password for the given ARN from the Key Store in order to access the device.

type Domain

string

param Domain

Specify the Active Directory Domain to restore the instance in.

type DomainIAMRoleName

string

param DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': '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'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': '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
    }
}

Response Structure

(dict) --
- DBInstance (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBInstance
  - DeleteDBInstance
  - ModifyDBInstance
  This data type is used as a response element in the DescribeDBInstances action.
  - 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) --
    
    Provides the name of the database engine to be used for this DB instance.
  - DBInstanceStatus (string) --
    
    Specifies the current state of this database.
  - 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. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.
    
    MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
    
    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.
    - 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 gigabytes.
  - 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) --
    
    Provides List of DB security group elements containing only 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 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 status of the VPC security group.
  - 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 DP 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 in the DescribeDBSubnetGroups action.
        
        SubnetIdentifier (string) --
        
        Specifies the identifier of the subnet.
        
        SubnetAvailabilityZone (dict) --
        
        Contains Availability Zone information.
        
        This data type is used as an element in the following data type:
        
        OrderableDBInstanceOption
        
        Name (string) --
        
        The name of the availability zone.
        
        SubnetStatus (string) --
        
        Specifies the status of the subnet.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - PendingModifiedValues (dict) --
    
    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) --
      
      Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
    - AllocatedStorage (integer) --
      
      Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
    - MasterUserPassword (string) --
      
      Contains the pending or in-progress change of the master credentials for the DB instance.
    - Port (integer) --
      
      Specifies the pending port for the DB instance.
    - BackupRetentionPeriod (integer) --
      
      Specifies the pending number of days for which automated backups are retained.
    - MultiAZ (boolean) --
      
      Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
    - EngineVersion (string) --
      
      Indicates 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) --
      
      Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
    - DBInstanceIdentifier (string) --
      
      Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
    - StorageType (string) --
      
      Specifies the storage type to be associated with the DB instance.
    - CACertificateIdentifier (string) --
      
      Specifies the identifier of the CA certificate for the DB instance.
    - DBSubnetGroupName (string) --
      
      The new DB subnet group for 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.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - AutoMinorVersionUpgrade (boolean) --
    
    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) --
  - LicenseModel (string) --
    
    License model information for this DB instance.
  - 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.
  - 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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
    
    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
    - Default VPC: true
    - VPC: false
    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
  - StatusInfos (list) --
    
    The status of a Read Replica. If the instance is not a Read Replica, this will be 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, error, stopped, or terminated.
      - Message (string) --
        
        Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
  - StorageType (string) --
    
    Specifies the storage type associated with 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 KMS key identifier for the encrypted DB instance.
  - DbiResourceId (string) --
    
    The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
  - CACertificateIdentifier (string) --
    
    The identifier of the CA certificate for this DB instance.
  - 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.
      - Domain (string) --
        
        The identifier of the Active Directory Domain.
      - Status (string) --
        
        The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
      - 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.
  - 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 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 .