Amazon Relational Database Service

2018/01/11 - Amazon Relational Database Service - 1 updated api methods

Changes  Read Replicas for Amazon RDS for MySQL, MariaDB, and PostgreSQL now support Multi-AZ deployments.Amazon RDS Read Replicas enable you to create one or more read-only copies of your database instance within the same AWS Region or in a different AWS Region. Updates made to the source database are asynchronously copied to the Read Replicas. In addition to providing scalability for read-heavy workloads, you can choose to promote a Read Replica to become standalone a DB instance when needed.Amazon RDS Multi-AZ Deployments provide enhanced availability for database instances within a single AWS Region. With Multi-AZ, your data is synchronously replicated to a standby in a different Availability Zone (AZ). In case of an infrastructure failure, Amazon RDS performs an automatic failover to the standby, minimizing disruption to your applications.You can now combine Read Replicas with Multi-AZ as part of a disaster recovery strategy for your production databases. A well-designed and tested plan is critical for maintaining business continuity after a disaster. Since Read Replicas can also be created in different regions than the source database, your Read Replica can be promoted to become the new production database in case of a regional disruption.You can also combine Read Replicas with Multi-AZ for your database engine upgrade process. You can create a Read Replica of your production database instance and upgrade it to a new database engine version. When the upgrade is complete, you can stop applications, promote the Read Replica to a standalone database instance and switch over your applications. Since the database instance is already a Multi-AZ deployment, no additional steps are needed.For more information, see the Amazon RDS User Guide.

CreateDBInstanceReadReplica (updated) Link ΒΆ
Changes (request)
{'MultiAZ': 'boolean'}

Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas.

Amazon Aurora does not support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

All Read Replica DB instances are created 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

Your source DB instance must have backup retention enabled.

See also: AWS API Documentation

Request Syntax

client.create_db_instance_read_replica(
    DBInstanceIdentifier='string',
    SourceDBInstanceIdentifier='string',
    DBInstanceClass='string',
    AvailabilityZone='string',
    Port=123,
    MultiAZ=True|False,
    AutoMinorVersionUpgrade=True|False,
    Iops=123,
    OptionGroupName='string',
    PubliclyAccessible=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DBSubnetGroupName='string',
    StorageType='string',
    CopyTagsToSnapshot=True|False,
    MonitoringInterval=123,
    MonitoringRoleArn='string',
    KmsKeyId='string',
    PreSignedUrl='string',
    EnableIAMDatabaseAuthentication=True|False,
    EnablePerformanceInsights=True|False,
    PerformanceInsightsKMSKeyId='string',
    SourceRegion='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 DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • 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 AWS Region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different AWS 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, for example, db.m4.large . Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

type AvailabilityZone

string

param AvailabilityZone

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

Default: A random, system-chosen Availability Zone in the endpoint's AWS 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 MultiAZ

boolean

param MultiAZ

Specifies whether the read replica is in a Multi-AZ deployment.

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Indicates that minor engine upgrades are 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 is associated with. If omitted, the default option group for the engine specified is used.

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 is 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 is private.

type Tags

list

param Tags

A list of tags. For more information, see Tagging Amazon RDS Resources.

  • (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 can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

    • Value (string) --

      A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type DBSubnetGroupName

string

param DBSubnetGroupName

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

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

  • If supplied, must match the name of an existing DBSubnetGroup.

  • The specified DB subnet group must be in the same AWS Region in which the operation is running.

  • All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

    • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

Example: 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, and 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

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

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

type KmsKeyId

string

param KmsKeyId

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you specify this parameter when you create a Read Replica from an unencrypted DB instance, the Read Replica is encrypted.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

type PreSignedUrl

string

param PreSignedUrl

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115 .

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Note

If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher.

Default: false

type EnablePerformanceInsights

boolean

param EnablePerformanceInsights

True to enable Performance Insights for the read replica, and otherwise false.

type PerformanceInsightsKMSKeyId

string

param PerformanceInsightsKMSKeyId

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

type SourceRegion

string

param SourceRegion

The ID of the region that contains the source for the 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'
                },
            ],
            'DBSubnetGroupArn': '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',
        ],
        'ReadReplicaDBClusterIdentifiers': [
            '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,
        'DBInstanceArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'PerformanceInsightsEnabled': True|False,
        'PerformanceInsightsKMSKeyId': 'string'
    }
}

Response Structure

  • (dict) --

    • DBInstance (dict) --

      Contains the details of an Amazon RDS DB instance.

      This data type is used as a response element in the 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

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

      • 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 a list of VPC security group elements that the DB instance belongs to.

        • (dict) --

          This data type is used as a response element for queries on VPC security group membership.

          • VpcSecurityGroupId (string) --

            The name of the VPC security group.

          • Status (string) --

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

        • DBSubnetGroupArn (string) --

          The Amazon Resource Name (ARN) for the DB subnet group.

      • 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 currently being applied.

        • AllocatedStorage (integer) --

          Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

        • MasterUserPassword (string) --

          Contains the pending or currently-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 currently being applied.

        • DBInstanceIdentifier (string) --

          Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

        • 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) --

      • ReadReplicaDBClusterIdentifiers (list) --

        Contains one or more identifiers of Aurora DB clusters that are Read Replicas of 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 is 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 is private.

      • StatusInfos (list) --

        The status of a Read Replica. If the instance is not a Read Replica, this is blank.

        • (dict) --

          Provides a list of status information for a DB instance.

          • StatusType (string) --

            This value is currently "read replication."

          • Normal (boolean) --

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status (string) --

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, 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 AWS KMS key identifier for the encrypted DB instance.

      • DbiResourceId (string) --

        The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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 Amazon CloudWatch Logs.

      • PromotionTier (integer) --

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

      • DBInstanceArn (string) --

        The Amazon Resource Name (ARN) for the DB instance.

      • Timezone (string) --

        The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        IAM database authentication can be enabled for the following database engines

        • For MySQL 5.6, minor version 5.6.34 or higher

        • For MySQL 5.7, minor version 5.7.16 or higher

        • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

      • PerformanceInsightsEnabled (boolean) --

        True if Performance Insights is enabled for the DB instance, and otherwise false.

      • PerformanceInsightsKMSKeyId (string) --

        The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.