Amazon Relational Database Service

{'DBSnapshot': {'DBSystemId': 'string'}}

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.

This command doesn't apply to RDS Custom.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide .

See also: AWS API Documentation

Request Syntax

client.copy_db_snapshot(
    SourceDBSnapshotIdentifier='string',
    TargetDBSnapshotIdentifier='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CopyTags=True|False,
    PreSignedUrl='string',
    OptionGroupName='string',
    TargetCustomAvailabilityZone='string',
    CopyOptionGroup=True|False,
    SourceRegion='string'
)

type SourceDBSnapshotIdentifier

string

param SourceDBSnapshotIdentifier

[REQUIRED]

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805 .

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 .

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

Constraints:

• Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

type TargetDBSnapshotIdentifier

string

param TargetDBSnapshotIdentifier

[REQUIRED]

The identifier for the copy of the snapshot.

Constraints:

• Can't be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

type Tags

list

param Tags

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

• (dict) --

  Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

  For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

  • Key (string) --

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

  • Value (string) --

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

type CopyTags

boolean

param CopyTags

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.

type PreSignedUrl

string

param PreSignedUrl

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

• DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

• KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

• SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 .

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

Note

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

Note

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

type OptionGroupName

string

param OptionGroupName

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide .

type TargetCustomAvailabilityZone

string

param TargetCustomAvailabilityZone

The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv .

type CopyOptionGroup

boolean

param CopyOptionGroup

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.

type SourceRegion

string

param SourceRegion

The ID of the region that contains the snapshot to be copied.

rtype

dict

returns

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DbiResourceId': 'string',
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotDatabaseTime': datetime(2015, 1, 1),
        'SnapshotTarget': 'string',
        'StorageThroughput': 123,
        'DBSystemId': 'string'
    }
}

Response Structure

• (dict) --

  • DBSnapshot (dict) --

    Contains the details of an Amazon RDS DB snapshot.

    This data type is used as a response element in the DescribeDBSnapshots action.

    • DBSnapshotIdentifier (string) --

      Specifies the identifier for the DB snapshot.

    • DBInstanceIdentifier (string) --

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB snapshot.

    • Port (integer) --

      Specifies the port that the database engine was listening on at the time of the snapshot.

    • AvailabilityZone (string) --

      Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB snapshot.

    • InstanceCreateTime (datetime) --

      Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

    • MasterUsername (string) --

      Provides the master username for the DB snapshot.

    • EngineVersion (string) --

      Specifies the version of the database engine.

    • LicenseModel (string) --

      License model information for the restored DB instance.

    • SnapshotType (string) --

      Provides the type of the DB snapshot.

    • Iops (integer) --

      Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    • OptionGroupName (string) --

      Provides the option group name for the DB snapshot.

    • PercentProgress (integer) --

      The percentage of the estimated data that has been transferred.

    • SourceRegion (string) --

      The Amazon Web Services Region that the DB snapshot was created in or copied from.

    • SourceDBSnapshotIdentifier (string) --

      The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

    • StorageType (string) --

      Specifies the storage type associated with DB snapshot.

    • TdeCredentialArn (string) --

      The ARN from the key store with which to associate the instance for TDE encryption.

    • Encrypted (boolean) --

      Specifies whether the DB snapshot is encrypted.

    • KmsKeyId (string) --

      If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DBSnapshotArn (string) --

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

    • Timezone (string) --

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

    • IAMDatabaseAuthenticationEnabled (boolean) --

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

    • ProcessorFeatures (list) --

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

      • (dict) --

        Contains the processor features of a DB instance class.

        To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

        You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

        • CreateDBInstance

        • ModifyDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceFromS3

        • RestoreDBInstanceToPointInTime

        You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

        In addition, you can use the following actions for DB instance class processor information:

        • DescribeDBInstances

        • DescribeDBSnapshots

        • DescribeValidDBInstanceModifications

        If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

        • You are accessing an Oracle DB instance.

        • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

        • The current number CPU cores and threads is set to a non-default value.

        For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

        • Name (string) --

          The name of the processor feature. Valid names are coreCount and threadsPerCore .

        • Value (string) --

          The value of a processor feature name.

    • DbiResourceId (string) --

      The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    • TagList (list) --

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) --

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) --

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

        • Value (string) --

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

    • OriginalSnapshotCreateTime (datetime) --

      Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

    • SnapshotDatabaseTime (datetime) --

      The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

      If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

    • SnapshotTarget (string) --

      Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • StorageThroughput (integer) --

      Specifies the storage throughput for the DB snapshot.

    • DBSystemId (string) --

      The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

{'DBSystemId': 'string'}

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

See also: AWS API Documentation

Request Syntax

client.create_db_instance(
    DBName='string',
    DBInstanceIdentifier='string',
    AllocatedStorage=123,
    DBInstanceClass='string',
    Engine='string',
    MasterUsername='string',
    MasterUserPassword='string',
    DBSecurityGroups=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    AvailabilityZone='string',
    DBSubnetGroupName='string',
    PreferredMaintenanceWindow='string',
    DBParameterGroupName='string',
    BackupRetentionPeriod=123,
    PreferredBackupWindow='string',
    Port=123,
    MultiAZ=True|False,
    EngineVersion='string',
    AutoMinorVersionUpgrade=True|False,
    LicenseModel='string',
    Iops=123,
    OptionGroupName='string',
    CharacterSetName='string',
    NcharCharacterSetName='string',
    PubliclyAccessible=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DBClusterIdentifier='string',
    StorageType='string',
    TdeCredentialArn='string',
    TdeCredentialPassword='string',
    StorageEncrypted=True|False,
    KmsKeyId='string',
    Domain='string',
    DomainFqdn='string',
    DomainOu='string',
    DomainAuthSecretArn='string',
    DomainDnsIps=[
        'string',
    ],
    CopyTagsToSnapshot=True|False,
    MonitoringInterval=123,
    MonitoringRoleArn='string',
    DomainIAMRoleName='string',
    PromotionTier=123,
    Timezone='string',
    EnableIAMDatabaseAuthentication=True|False,
    EnablePerformanceInsights=True|False,
    PerformanceInsightsKMSKeyId='string',
    PerformanceInsightsRetentionPeriod=123,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    ProcessorFeatures=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    DeletionProtection=True|False,
    MaxAllocatedStorage=123,
    EnableCustomerOwnedIp=True|False,
    CustomIamInstanceProfile='string',
    BackupTarget='string',
    NetworkType='string',
    StorageThroughput=123,
    ManageMasterUserPassword=True|False,
    MasterUserSecretKmsKeyId='string',
    CACertificateIdentifier='string',
    DBSystemId='string'
)

type DBName

string

param DBName

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

MySQL

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

Constraints:

• Must contain 1 to 64 letters or numbers.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can't be a word reserved by the specified database engine

MariaDB

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

Constraints:

• Must contain 1 to 64 letters or numbers.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can't be a word reserved by the specified database engine

PostgreSQL

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

Constraints:

• Must contain 1 to 63 letters, numbers, or underscores.

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

• Can't be a word reserved by the specified database engine

Oracle

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

Default: ORCL

Constraints:

• Can't be longer than 8 characters

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and RDSCDB for CDBs.

Default: ORCL

Constraints:

• It must contain 1 to 8 alphanumeric characters.

• It must contain a letter.

• It can't be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

SQL Server

Not applicable. Must be null.

Amazon Aurora MySQL

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

Constraints:

• It must contain 1 to 64 alphanumeric characters.

• It can't be a word reserved by the database engine.

Amazon Aurora PostgreSQL

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

Constraints:

• It must contain 1 to 63 alphanumeric characters.

• It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).

• It can't be a word reserved by the database engine.

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

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

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

type AllocatedStorage

integer

param AllocatedStorage

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

• Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

  RDS for MariaDB

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

  RDS for MySQL

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

  RDS for Oracle

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 10 to 3072.

  RDS for PostgreSQL

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

• Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

• Magnetic storage (standard): Must be an integer from 5 to 3072.

  RDS for SQL Server

Constraints to the amount of storage for each storage type are the following:

• General Purpose (SSD) storage (gp2, gp3):

  • Enterprise and Standard editions: Must be an integer from 20 to 16384.

  • Web and Express editions: Must be an integer from 20 to 16384.

• Provisioned IOPS storage (io1):

  • Enterprise and Standard editions: Must be an integer from 100 to 16384.

  • Web and Express editions: Must be an integer from 100 to 16384.

• Magnetic storage (standard):

  • Enterprise and Standard editions: Must be an integer from 20 to 1024.

  • Web and Express editions: Must be an integer from 20 to 1024.

type DBInstanceClass

string

param DBInstanceClass

[REQUIRED]

The compute and memory capacity of the DB instance, for example db.m5.large . Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .

type Engine

string

param Engine

[REQUIRED]

The database engine to use for this DB instance.

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

Valid Values:

• aurora-mysql (for Aurora MySQL DB instances)

• aurora-postgresql (for Aurora PostgreSQL DB instances)

• custom-oracle-ee (for RDS Custom for Oracle DB instances)

• custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

• custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

• custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

• custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

type MasterUsername

string

param MasterUsername

The name for the master user.

This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

This setting is required for RDS DB instances.

Constraints:

• Must be 1 to 16 letters, numbers, or underscores.

• First character must be a letter.

• Can't be a reserved word for the chosen database engine.

type MasterUserPassword

string

param MasterUserPassword

The password for the master user.

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster.

Constraints:

• Can't be specified if ManageMasterUserPassword is turned on.

• Can include any printable ASCII character except "/", """, or "@".

Length Constraints:

• RDS for MariaDB - Must contain from 8 to 41 characters.

• RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

• RDS for MySQL - Must contain from 8 to 41 characters.

• RDS for Oracle - Must contain from 8 to 30 characters.

• RDS for PostgreSQL - Must contain from 8 to 128 characters.

type DBSecurityGroups

list

param DBSecurityGroups

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

This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

• (string) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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

This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

• (string) --

type AvailabilityZone

string

param AvailabilityZone

The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Constraints:

• The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.

• The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

Example: us-east-1d

type DBSubnetGroupName

string

param DBSubnetGroupName

A DB subnet group to associate with this DB instance.

Constraints:

• Must match the name of an existing DB subnet group.

• Must not be default .

Example: mydbsubnetgroup

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

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

Constraints:

• Must be in the format ddd:hh24:mi-ddd:hh24:mi .

• The day values must be mon | tue | wed | thu | fri | sat | sun .

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred backup window.

• Must be at least 30 minutes.

type DBParameterGroupName

string

param DBParameterGroupName

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.

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

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• The first character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

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.

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

• Must be a value from 0 to 35.

• Can't be set to 0 if the DB instance is a source to read replicas.

• Can't be set to 0 for an RDS Custom for Oracle DB instance.

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide .

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster.

Constraints:

• Must be in the format hh24:mi-hh24:mi .

• Must be in Universal Coordinated Time (UTC).

• Must not conflict with the preferred maintenance window.

• Must be at least 30 minutes.

type Port

integer

param Port

The port number on which the database accepts connections.

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

Valid Values: 1150-65535

Default:

• RDS for MariaDB - 3306

• RDS for Microsoft SQL Server - 1433

• RDS for MySQL - 3306

• RDS for Oracle - 1521

• RDS for PostgreSQL - 5432

Constraints:

• For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , or 49152-49156 .

type MultiAZ

boolean

param MultiAZ

Specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

This setting doesn't apply to the following DB instances:

• Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

• RDS Custom

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.*customized_string* . A valid CEV name is 19.my_cev1 . For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide .

Amazon RDS Custom for SQL Server

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

RDS for MariaDB

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

RDS for Microsoft SQL Server

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

RDS for MySQL

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

RDS for Oracle

For information, see Oracle Database Engine release notes in the Amazon RDS User Guide .

RDS for PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide .

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false .

type LicenseModel

string

param LicenseModel

The license model information for this DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Valid Values:

• RDS for MariaDB - general-public-license

• RDS for Microsoft SQL Server - license-included

• RDS for MySQL - general-public-license

• RDS for Oracle - bring-your-own-license | license-included

• RDS for PostgreSQL - postgresql-license

type Iops

integer

param Iops

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

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

Constraints:

• For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.

• For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

type OptionGroupName

string

param OptionGroupName

The option group to associate the DB instance with.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

type CharacterSetName

string

param CharacterSetName

For supported engines, the character set (CharacterSet ) to associate the DB instance with.

This setting doesn't apply to the following DB instances:

• Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster .

• RDS Custom - However, if you need to change the character set, you can change it on the database itself.

type NcharCharacterSetName

string

param NcharCharacterSetName

The name of the NCHAR character set for the Oracle DB instance.

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

type PubliclyAccessible

boolean

param PubliclyAccessible

Specifies whether the DB instance is publicly accessible.

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

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

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

• If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

• If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

• If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

• If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

type Tags

list

param Tags

Tags to assign to the DB instance.

• (dict) --

  Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

  For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

  • Key (string) --

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

  • Value (string) --

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

type DBClusterIdentifier

string

param DBClusterIdentifier

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

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

type StorageType

string

param StorageType

The storage type to associate with the DB instance.

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

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

Valid Values: gp2 | gp3 | io1 | standard

Default: io1 , if the Iops parameter is specified. Otherwise, gp2 .

type TdeCredentialArn

string

param TdeCredentialArn

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

type TdeCredentialPassword

string

param TdeCredentialPassword

The password for the given ARN from the key store in order to access the device.

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

type StorageEncrypted

boolean

param StorageEncrypted

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster .

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted , the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.

type Domain

string

param Domain

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide .

This setting doesn't apply to the following DB instances:

• Amazon Aurora (The domain is managed by the DB cluster.)

• RDS Custom

type DomainFqdn

string

param DomainFqdn

The fully qualified domain name (FQDN) of an Active Directory domain.

Constraints:

• Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

type DomainOu

string

param DomainOu

The Active Directory organizational unit for your DB instance to join.

Constraints:

• Must be in the distinguished name format.

• Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

type DomainAuthSecretArn

string

param DomainAuthSecretArn

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

type DomainDnsIps

list

param DomainDnsIps

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Constraints:

• Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

• (string) --

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

type MonitoringInterval

integer

param MonitoringInterval

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

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

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

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

Default: 0

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, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide .

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

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

type DomainIAMRoleName

string

param DomainIAMRoleName

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn't apply to the following DB instances:

• Amazon Aurora (The domain is managed by the DB cluster.)

• RDS Custom

type PromotionTier

integer

param PromotionTier

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .

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

Default: 1

Valid Values: 0 - 15

type Timezone

string

param Timezone

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server .

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide .

This setting doesn't apply to the following DB instances:

• Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

• RDS Custom

type EnablePerformanceInsights

boolean

param EnablePerformanceInsights

Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .

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

type PerformanceInsightsKMSKeyId

string

param PerformanceInsightsKMSKeyId

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

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

type PerformanceInsightsRetentionPeriod

integer

param PerformanceInsightsRetentionPeriod

The number of days to retain Performance Insights data.

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

Valid Values:

• 7

• month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

• 731

Default: 7 days

If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.

type EnableCloudwatchLogsExports

list

param EnableCloudwatchLogsExports

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .

This setting doesn't apply to the following DB instances:

• Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

• RDS Custom

The following values are valid for each DB engine:

• RDS for MariaDB - audit | error | general | slowquery

• RDS for Microsoft SQL Server - agent | error

• RDS for MySQL - audit | error | general | slowquery

• RDS for Oracle - alert | audit | listener | trace | oemagent

• RDS for PostgreSQL - postgresql | upgrade

• (string) --

type ProcessorFeatures

list

param ProcessorFeatures

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

• (dict) --

  Contains the processor features of a DB instance class.

  To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

  You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

  You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

  In addition, you can use the following actions for DB instance class processor information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

  If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

  • You are accessing an Oracle DB instance.

  • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

  For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

  • Name (string) --

    The name of the processor feature. Valid names are coreCount and threadsPerCore .

  • Value (string) --

    The value of a processor feature name.

type DeletionProtection

boolean

param DeletionProtection

Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

type MaxAllocatedStorage

integer

param MaxAllocatedStorage

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .

This setting doesn't apply to the following DB instances:

• Amazon Aurora (Storage is managed by the DB cluster.)

• RDS Custom

type EnableCustomerOwnedIp

boolean

param EnableCustomerOwnedIp

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .

type CustomIamInstanceProfile

string

param CustomIamInstanceProfile

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

This setting is required for RDS Custom.

Constraints:

• The profile must exist in your account.

• The profile must have an IAM role that Amazon EC2 has permissions to assume.

• The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

type BackupTarget

string

param BackupTarget

The location for storing automated backups and manual snapshots.

Valie Values:

• outposts (Amazon Web Services Outposts)

• region (Amazon Web Services Region)

Default: region

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .

type NetworkType

string

param NetworkType

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Valid Values: IPV4 | DUAL

type StorageThroughput

integer

param StorageThroughput

The storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

type ManageMasterUserPassword

boolean

param ManageMasterUserPassword

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

• Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

type MasterUserSecretKmsKeyId

string

param MasterUserSecretKmsKeyId

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

type CACertificateIdentifier

string

param CACertificateIdentifier

The CA certificate identifier to use for the DB instance's server certificate.

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

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .

type DBSystemId

string

param DBSystemId

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB . The Oracle SID is also the name of your CDB.

rtype

dict

returns

Response Syntax

{
    'DBInstance': {
        'DBInstanceIdentifier': 'string',
        'DBInstanceClass': 'string',
        'Engine': 'string',
        'DBInstanceStatus': 'string',
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'AllocatedStorage': 123,
        'InstanceCreateTime': datetime(2015, 1, 1),
        'PreferredBackupWindow': 'string',
        'BackupRetentionPeriod': 123,
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'DBSubnetGroup': {
            'DBSubnetGroupName': 'string',
            'DBSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetOutpost': {
                        'Arn': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ],
            'DBSubnetGroupArn': 'string',
            'SupportedNetworkTypes': [
                'string',
            ]
        },
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'DBInstanceClass': 'string',
            'AllocatedStorage': 123,
            'MasterUserPassword': 'string',
            'Port': 123,
            'BackupRetentionPeriod': 123,
            'MultiAZ': True|False,
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'Iops': 123,
            'DBInstanceIdentifier': 'string',
            'StorageType': 'string',
            'CACertificateIdentifier': 'string',
            'DBSubnetGroupName': 'string',
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'ProcessorFeatures': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'IAMDatabaseAuthenticationEnabled': True|False,
            'AutomationMode': 'full'|'all-paused',
            'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
            'StorageThroughput': 123,
            'Engine': 'string'
        },
        'LatestRestorableTime': datetime(2015, 1, 1),
        'MultiAZ': True|False,
        'EngineVersion': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaDBClusterIdentifiers': [
            'string',
        ],
        'ReplicaMode': 'open-read-only'|'mounted',
        'LicenseModel': 'string',
        'Iops': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CharacterSetName': 'string',
        'NcharCharacterSetName': 'string',
        'SecondaryAvailabilityZone': 'string',
        'PubliclyAccessible': True|False,
        'StatusInfos': [
            {
                'StatusType': 'string',
                'Normal': True|False,
                'Status': 'string',
                'Message': 'string'
            },
        ],
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'DbInstancePort': 123,
        'DBClusterIdentifier': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbiResourceId': 'string',
        'CACertificateIdentifier': 'string',
        'DomainMemberships': [
            {
                'Domain': 'string',
                'Status': 'string',
                'FQDN': 'string',
                'IAMRoleName': 'string',
                'OU': 'string',
                'AuthSecretArn': 'string',
                'DnsIps': [
                    'string',
                ]
            },
        ],
        'CopyTagsToSnapshot': True|False,
        'MonitoringInterval': 123,
        'EnhancedMonitoringResourceArn': 'string',
        'MonitoringRoleArn': 'string',
        'PromotionTier': 123,
        'DBInstanceArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'PerformanceInsightsEnabled': True|False,
        'PerformanceInsightsKMSKeyId': 'string',
        'PerformanceInsightsRetentionPeriod': 123,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DeletionProtection': True|False,
        'AssociatedRoles': [
            {
                'RoleArn': 'string',
                'FeatureName': 'string',
                'Status': 'string'
            },
        ],
        'ListenerEndpoint': {
            'Address': 'string',
            'Port': 123,
            'HostedZoneId': 'string'
        },
        'MaxAllocatedStorage': 123,
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'DBInstanceAutomatedBackupsReplications': [
            {
                'DBInstanceAutomatedBackupsArn': 'string'
            },
        ],
        'CustomerOwnedIpEnabled': True|False,
        'AwsBackupRecoveryPointArn': 'string',
        'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
        'ActivityStreamKmsKeyId': 'string',
        'ActivityStreamKinesisStreamName': 'string',
        'ActivityStreamMode': 'sync'|'async',
        'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
        'AutomationMode': 'full'|'all-paused',
        'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
        'CustomIamInstanceProfile': 'string',
        'BackupTarget': 'string',
        'NetworkType': 'string',
        'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy',
        'StorageThroughput': 123,
        'DBSystemId': 'string',
        'MasterUserSecret': {
            'SecretArn': 'string',
            'SecretStatus': 'string',
            'KmsKeyId': 'string'
        },
        'CertificateDetails': {
            'CAIdentifier': 'string',
            'ValidTill': datetime(2015, 1, 1)
        },
        'ReadReplicaSourceDBClusterIdentifier': 'string'
    }
}

Response Structure

• (dict) --

  • DBInstance (dict) --

    Contains the details of an Amazon RDS DB instance.

    This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .

    • DBInstanceIdentifier (string) --

      The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    • DBInstanceClass (string) --

      The name of the compute and memory capacity class of the DB instance.

    • Engine (string) --

      The database engine used for this DB instance.

    • DBInstanceStatus (string) --

      The current state of this database.

      For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

    • AutomaticRestartTime (datetime) --

      The time when a stopped DB instance is restarted automatically.

    • MasterUsername (string) --

      The master username for the DB instance.

    • DBName (string) --

      Contains the initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

    • Endpoint (dict) --

      The connection endpoint for the DB instance.

      Note

      The endpoint might not be shown for instances with the status of creating .

      • Address (string) --

        Specifies the DNS address of the DB instance.

      • Port (integer) --

        Specifies the port that the database engine is listening on.

      • HostedZoneId (string) --

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    • AllocatedStorage (integer) --

      The amount of storage in gibibytes (GiB) allocated for the DB instance.

    • InstanceCreateTime (datetime) --

      The date and time when the DB instance was created.

    • PreferredBackupWindow (string) --

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

    • BackupRetentionPeriod (integer) --

      The number of days for which automatic DB snapshots are retained.

    • DBSecurityGroups (list) --

      A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

      • (dict) --

        This data type is used as a response element in the following actions:

        • ModifyDBInstance

        • RebootDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceToPointInTime

        • DBSecurityGroupName (string) --

          The name of the DB security group.

        • Status (string) --

          The status of the DB security group.

    • VpcSecurityGroups (list) --

      The list of Amazon EC2 VPC security groups that the DB instance belongs to.

      • (dict) --

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

        • VpcSecurityGroupId (string) --

          The name of the VPC security group.

        • Status (string) --

          The membership status of the VPC security group.

          Currently, the only valid status is active .

    • DBParameterGroups (list) --

      The list of DB parameter groups applied to this DB instance.

      • (dict) --

        The status of the DB parameter group.

        This data type is used as a response element in the following actions:

        • CreateDBInstance

        • CreateDBInstanceReadReplica

        • DeleteDBInstance

        • ModifyDBInstance

        • RebootDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • DBParameterGroupName (string) --

          The name of the DB parameter group.

        • ParameterApplyStatus (string) --

          The status of parameter updates.

    • AvailabilityZone (string) --

      The name of the Availability Zone where the DB instance is located.

    • DBSubnetGroup (dict) --

      Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

      • DBSubnetGroupName (string) --

        The name of the DB subnet group.

      • DBSubnetGroupDescription (string) --

        Provides the description of the DB subnet group.

      • VpcId (string) --

        Provides the VpcId of the DB subnet group.

      • SubnetGroupStatus (string) --

        Provides the status of the DB subnet group.

      • Subnets (list) --

        Contains a list of Subnet elements.

        • (dict) --

          This data type is used as a response element for the DescribeDBSubnetGroups operation.

          • SubnetIdentifier (string) --

            The identifier of the subnet.

          • SubnetAvailabilityZone (dict) --

            Contains Availability Zone information.

            This data type is used as an element in the OrderableDBInstanceOption data type.

            • Name (string) --

              The name of the Availability Zone.

          • SubnetOutpost (dict) --

            If the subnet is associated with an Outpost, this value specifies the Outpost.

            For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the Outpost.

          • SubnetStatus (string) --

            The status of the subnet.

      • DBSubnetGroupArn (string) --

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

      • SupportedNetworkTypes (list) --

        The network type of the DB subnet group.

        Valid values:

        • IPV4

        • DUAL

        A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

        For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

        • (string) --

    • PreferredMaintenanceWindow (string) --

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

    • PendingModifiedValues (dict) --

      Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

      • DBInstanceClass (string) --

        The name of the compute and memory capacity class for the DB instance.

      • AllocatedStorage (integer) --

        The allocated storage size for the DB instance specified in gibibytes (GiB).

      • MasterUserPassword (string) --

        The master credentials for the DB instance.

      • Port (integer) --

        The port for the DB instance.

      • BackupRetentionPeriod (integer) --

        The number of days for which automated backups are retained.

      • MultiAZ (boolean) --

        A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

      • EngineVersion (string) --

        The database engine version.

      • LicenseModel (string) --

        The license model for the DB instance.

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

      • Iops (integer) --

        The Provisioned IOPS value for the DB instance.

      • DBInstanceIdentifier (string) --

        The database identifier for the DB instance.

      • StorageType (string) --

        The storage type of the DB instance.

      • CACertificateIdentifier (string) --

        The identifier of the CA certificate for the DB instance.

        For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .

      • DBSubnetGroupName (string) --

        The DB subnet group for the DB instance.

      • PendingCloudwatchLogsExports (dict) --

        A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • ProcessorFeatures (list) --

        The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

        • (dict) --

          Contains the processor features of a DB instance class.

          To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

          You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

          • CreateDBInstance

          • ModifyDBInstance

          • RestoreDBInstanceFromDBSnapshot

          • RestoreDBInstanceFromS3

          • RestoreDBInstanceToPointInTime

          You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

          In addition, you can use the following actions for DB instance class processor information:

          • DescribeDBInstances

          • DescribeDBSnapshots

          • DescribeValidDBInstanceModifications

          If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

          • You are accessing an Oracle DB instance.

          • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

          • The current number CPU cores and threads is set to a non-default value.

          For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

          • Name (string) --

            The name of the processor feature. Valid names are coreCount and threadsPerCore .

          • Value (string) --

            The value of a processor feature name.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • AutomationMode (string) --

        The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .

      • ResumeFullAutomationModeTime (datetime) --

        The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

      • StorageThroughput (integer) --

        The storage throughput of the DB instance.

      • Engine (string) --

        The database engine of the DB instance.

    • LatestRestorableTime (datetime) --

      The latest time to which a database in this DB instance can be restored with point-in-time restore.

    • MultiAZ (boolean) --

      Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

    • EngineVersion (string) --

      The version of the database engine.

    • AutoMinorVersionUpgrade (boolean) --

      Indicates whether minor version patches are applied automatically.

    • ReadReplicaSourceDBInstanceIdentifier (string) --

      The identifier of the source DB instance if this DB instance is a read replica.

    • ReadReplicaDBInstanceIdentifiers (list) --

      The identifiers of the read replicas associated with this DB instance.

      • (string) --

    • ReadReplicaDBClusterIdentifiers (list) --

      The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.

      Note

      Currently, each RDS DB instance can have only one Aurora read replica.

      • (string) --

    • ReplicaMode (string) --

      The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .

      Note

      This attribute is only supported in RDS for Oracle.

    • LicenseModel (string) --

      The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

    • Iops (integer) --

      The Provisioned IOPS (I/O operations per second) value for the DB instance.

    • OptionGroupMemberships (list) --

      The list of option group memberships for this DB instance.

      • (dict) --

        Provides information on the option groups the DB instance is a member of.

        • OptionGroupName (string) --

          The name of the option group that the instance belongs to.

        • Status (string) --

          The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .

    • CharacterSetName (string) --

      If present, specifies the name of the character set that this instance is associated with.

    • NcharCharacterSetName (string) --

      The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

    • SecondaryAvailabilityZone (string) --

      If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    • PubliclyAccessible (boolean) --

      Indicates whether the DB instance is publicly accessible.

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

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

      For more information, see CreateDBInstance .

    • StatusInfos (list) --

      The status of a read replica. If the DB instance isn't a read replica, the value is blank.

      • (dict) --

        Provides a list of status information for a DB instance.

        • StatusType (string) --

          This value is currently "read replication."

        • Normal (boolean) --

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

        • Status (string) --

          Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

        • Message (string) --

          Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

    • StorageType (string) --

      The storage type associated with the DB instance.

    • TdeCredentialArn (string) --

      The ARN from the key store with which the instance is associated for TDE encryption.

    • DbInstancePort (integer) --

      The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

    • DBClusterIdentifier (string) --

      If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

    • StorageEncrypted (boolean) --

      Indicates whether the DB instance is encrypted.

    • KmsKeyId (string) --

      If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DbiResourceId (string) --

      The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

    • CACertificateIdentifier (string) --

      The identifier of the CA certificate for this DB instance.

      For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .

    • DomainMemberships (list) --

      The Active Directory Domain membership records associated with the DB instance.

      • (dict) --

        An Active Directory Domain membership record associated with the DB instance or cluster.

        • Domain (string) --

          The identifier of the Active Directory Domain.

        • Status (string) --

          The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined , pending-join , failed , and so on.

        • FQDN (string) --

          The fully qualified domain name (FQDN) of the Active Directory Domain.

        • IAMRoleName (string) --

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

        • OU (string) --

          The Active Directory organizational unit for the DB instance or cluster.

        • AuthSecretArn (string) --

          The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

        • DnsIps (list) --

          The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

          • (string) --

    • CopyTagsToSnapshot (boolean) --

      Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

      This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .

    • MonitoringInterval (integer) --

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    • EnhancedMonitoringResourceArn (string) --

      The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    • MonitoringRoleArn (string) --

      The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    • PromotionTier (integer) --

      The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .

    • DBInstanceArn (string) --

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

    • Timezone (string) --

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

    • IAMDatabaseAuthenticationEnabled (boolean) --

      Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

      For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide .

    • PerformanceInsightsEnabled (boolean) --

      Indicates whether Performance Insights is enabled for the DB instance.

    • PerformanceInsightsKMSKeyId (string) --

      The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • PerformanceInsightsRetentionPeriod (integer) --

      The number of days to retain Performance Insights data.

      Valid Values:

      • 7

      • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

      • 731

      Default: 7 days

    • EnabledCloudwatchLogsExports (list) --

      A list of log types that this DB instance is configured to export to CloudWatch Logs.

      Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.

      • (string) --

    • ProcessorFeatures (list) --

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      • (dict) --

        Contains the processor features of a DB instance class.

        To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

        You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

        • CreateDBInstance

        • ModifyDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceFromS3

        • RestoreDBInstanceToPointInTime

        You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

        In addition, you can use the following actions for DB instance class processor information:

        • DescribeDBInstances

        • DescribeDBSnapshots

        • DescribeValidDBInstanceModifications

        If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

        • You are accessing an Oracle DB instance.

        • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

        • The current number CPU cores and threads is set to a non-default value.

        For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

        • Name (string) --

          The name of the processor feature. Valid names are coreCount and threadsPerCore .

        • Value (string) --

          The value of a processor feature name.

    • DeletionProtection (boolean) --

      Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .

    • AssociatedRoles (list) --

      The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

      • (dict) --

        Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

        • RoleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .

        • Status (string) --

          Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

          • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB instance.

          • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    • ListenerEndpoint (dict) --

      The listener connection endpoint for SQL Server Always On.

      • Address (string) --

        Specifies the DNS address of the DB instance.

      • Port (integer) --

        Specifies the port that the database engine is listening on.

      • HostedZoneId (string) --

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    • MaxAllocatedStorage (integer) --

      The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

    • TagList (list) --

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) --

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) --

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

        • Value (string) --

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

    • DBInstanceAutomatedBackupsReplications (list) --

      The list of replicated automated backups associated with the DB instance.

      • (dict) --

        Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

        • DBInstanceAutomatedBackupsArn (string) --

          The Amazon Resource Name (ARN) of the replicated automated backups.

    • CustomerOwnedIpEnabled (boolean) --

      Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

      A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

      For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .

      For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .

    • AwsBackupRecoveryPointArn (string) --

      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

    • ActivityStreamStatus (string) --

      The status of the database activity stream.

    • ActivityStreamKmsKeyId (string) --

      The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • ActivityStreamKinesisStreamName (string) --

      The name of the Amazon Kinesis data stream used for the database activity stream.

    • ActivityStreamMode (string) --

      The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

    • ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --

      Indicates whether engine-native audit fields are included in the database activity stream.

    • AutomationMode (string) --

      The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .

    • ResumeFullAutomationModeTime (datetime) --

      The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

    • CustomIamInstanceProfile (string) --

      The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

      • The profile must exist in your account.

      • The profile must have an IAM role that Amazon EC2 has permissions to assume.

      • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .

      For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

    • BackupTarget (string) --

      The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • NetworkType (string) --

      The network type of the DB instance.

      The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

      For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid Values: IPV4 | DUAL

    • ActivityStreamPolicyStatus (string) --

      The status of the policy state of the activity stream.

    • StorageThroughput (integer) --

      The storage throughput for the DB instance.

      This setting applies only to the gp3 storage type.

    • DBSystemId (string) --

      The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

    • MasterUserSecret (dict) --

      The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

      • SecretArn (string) --

        The Amazon Resource Name (ARN) of the secret.

      • SecretStatus (string) --

        The status of the secret.

        The possible status values include the following:

        • creating - The secret is being created.

        • active - The secret is available for normal use and rotation.

        • rotating - The secret is being rotated.

        • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

      • KmsKeyId (string) --

        The Amazon Web Services KMS key identifier that is used to encrypt the secret.

    • CertificateDetails (dict) --

      The details of the DB instance's server certificate.

      • CAIdentifier (string) --

        The CA identifier of the CA certificate used for the DB instance's server certificate.

      • ValidTill (datetime) --

        The expiration date of the DB instance’s server certificate.

    • ReadReplicaSourceDBClusterIdentifier (string) --

      The identifier of the source DB cluster if this DB instance is a read replica.

{'DBSnapshot': {'DBSystemId': 'string'}}

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

See also: AWS API Documentation

Request Syntax

client.create_db_snapshot(
    DBSnapshotIdentifier='string',
    DBInstanceIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type DBSnapshotIdentifier

string

param DBSnapshotIdentifier

[REQUIRED]

The identifier for the DB snapshot.

Constraints:

• Can't be null, empty, or blank

• Must contain from 1 to 255 letters, numbers, or hyphens

• First character must be a letter

• Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

type DBInstanceIdentifier

string

param DBInstanceIdentifier

[REQUIRED]

The identifier of the DB instance that you want to create the snapshot of.

Constraints:

• Must match the identifier of an existing DBInstance.

type Tags

list

param Tags

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

• (dict) --

  Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

  For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

  • Key (string) --

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

  • Value (string) --

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

rtype

dict

returns

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DbiResourceId': 'string',
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotDatabaseTime': datetime(2015, 1, 1),
        'SnapshotTarget': 'string',
        'StorageThroughput': 123,
        'DBSystemId': 'string'
    }
}

Response Structure

• (dict) --

  • DBSnapshot (dict) --

    Contains the details of an Amazon RDS DB snapshot.

    This data type is used as a response element in the DescribeDBSnapshots action.

    • DBSnapshotIdentifier (string) --

      Specifies the identifier for the DB snapshot.

    • DBInstanceIdentifier (string) --

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB snapshot.

    • Port (integer) --

      Specifies the port that the database engine was listening on at the time of the snapshot.

    • AvailabilityZone (string) --

      Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB snapshot.

    • InstanceCreateTime (datetime) --

      Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

    • MasterUsername (string) --

      Provides the master username for the DB snapshot.

    • EngineVersion (string) --

      Specifies the version of the database engine.

    • LicenseModel (string) --

      License model information for the restored DB instance.

    • SnapshotType (string) --

      Provides the type of the DB snapshot.

    • Iops (integer) --

      Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    • OptionGroupName (string) --

      Provides the option group name for the DB snapshot.

    • PercentProgress (integer) --

      The percentage of the estimated data that has been transferred.

    • SourceRegion (string) --

      The Amazon Web Services Region that the DB snapshot was created in or copied from.

    • SourceDBSnapshotIdentifier (string) --

      The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

    • StorageType (string) --

      Specifies the storage type associated with DB snapshot.

    • TdeCredentialArn (string) --

      The ARN from the key store with which to associate the instance for TDE encryption.

    • Encrypted (boolean) --

      Specifies whether the DB snapshot is encrypted.

    • KmsKeyId (string) --

      If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DBSnapshotArn (string) --

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

    • Timezone (string) --

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

    • IAMDatabaseAuthenticationEnabled (boolean) --

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

    • ProcessorFeatures (list) --

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

      • (dict) --

        Contains the processor features of a DB instance class.

        To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

        You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

        • CreateDBInstance

        • ModifyDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceFromS3

        • RestoreDBInstanceToPointInTime

        You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

        In addition, you can use the following actions for DB instance class processor information:

        • DescribeDBInstances

        • DescribeDBSnapshots

        • DescribeValidDBInstanceModifications

        If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

        • You are accessing an Oracle DB instance.

        • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

        • The current number CPU cores and threads is set to a non-default value.

        For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

        • Name (string) --

          The name of the processor feature. Valid names are coreCount and threadsPerCore .

        • Value (string) --

          The value of a processor feature name.

    • DbiResourceId (string) --

      The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    • TagList (list) --

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) --

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) --

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

        • Value (string) --

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

    • OriginalSnapshotCreateTime (datetime) --

      Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

    • SnapshotDatabaseTime (datetime) --

      The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

      If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

    • SnapshotTarget (string) --

      Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • StorageThroughput (integer) --

      Specifies the storage throughput for the DB snapshot.

    • DBSystemId (string) --

      The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

{'DBSnapshot': {'DBSystemId': 'string'}}

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

See also: AWS API Documentation

Request Syntax

client.delete_db_snapshot(
    DBSnapshotIdentifier='string'
)

type DBSnapshotIdentifier

string

param DBSnapshotIdentifier

[REQUIRED]

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

rtype

dict

returns

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DbiResourceId': 'string',
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotDatabaseTime': datetime(2015, 1, 1),
        'SnapshotTarget': 'string',
        'StorageThroughput': 123,
        'DBSystemId': 'string'
    }
}

Response Structure

• (dict) --

  • DBSnapshot (dict) --

    Contains the details of an Amazon RDS DB snapshot.

    This data type is used as a response element in the DescribeDBSnapshots action.

    • DBSnapshotIdentifier (string) --

      Specifies the identifier for the DB snapshot.

    • DBInstanceIdentifier (string) --

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB snapshot.

    • Port (integer) --

      Specifies the port that the database engine was listening on at the time of the snapshot.

    • AvailabilityZone (string) --

      Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB snapshot.

    • InstanceCreateTime (datetime) --

      Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

    • MasterUsername (string) --

      Provides the master username for the DB snapshot.

    • EngineVersion (string) --

      Specifies the version of the database engine.

    • LicenseModel (string) --

      License model information for the restored DB instance.

    • SnapshotType (string) --

      Provides the type of the DB snapshot.

    • Iops (integer) --

      Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    • OptionGroupName (string) --

      Provides the option group name for the DB snapshot.

    • PercentProgress (integer) --

      The percentage of the estimated data that has been transferred.

    • SourceRegion (string) --

      The Amazon Web Services Region that the DB snapshot was created in or copied from.

    • SourceDBSnapshotIdentifier (string) --

      The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

    • StorageType (string) --

      Specifies the storage type associated with DB snapshot.

    • TdeCredentialArn (string) --

      The ARN from the key store with which to associate the instance for TDE encryption.

    • Encrypted (boolean) --

      Specifies whether the DB snapshot is encrypted.

    • KmsKeyId (string) --

      If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DBSnapshotArn (string) --

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

    • Timezone (string) --

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

    • IAMDatabaseAuthenticationEnabled (boolean) --

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

    • ProcessorFeatures (list) --

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

      • (dict) --

        Contains the processor features of a DB instance class.

        To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

        You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

        • CreateDBInstance

        • ModifyDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceFromS3

        • RestoreDBInstanceToPointInTime

        You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

        In addition, you can use the following actions for DB instance class processor information:

        • DescribeDBInstances

        • DescribeDBSnapshots

        • DescribeValidDBInstanceModifications

        If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

        • You are accessing an Oracle DB instance.

        • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

        • The current number CPU cores and threads is set to a non-default value.

        For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

        • Name (string) --

          The name of the processor feature. Valid names are coreCount and threadsPerCore .

        • Value (string) --

          The value of a processor feature name.

    • DbiResourceId (string) --

      The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    • TagList (list) --

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) --

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) --

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

        • Value (string) --

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

    • OriginalSnapshotCreateTime (datetime) --

      Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

    • SnapshotDatabaseTime (datetime) --

      The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

      If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

    • SnapshotTarget (string) --

      Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • StorageThroughput (integer) --

      Specifies the storage throughput for the DB snapshot.

    • DBSystemId (string) --

      The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

{'DBSnapshots': {'DBSystemId': 'string'}}

Returns information about DB snapshots. This API action supports pagination.

See also: AWS API Documentation

Request Syntax

client.describe_db_snapshots(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string',
    SnapshotType='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    IncludeShared=True|False,
    IncludePublic=True|False,
    DbiResourceId='string'
)

type DBInstanceIdentifier

string

param DBInstanceIdentifier

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

type DBSnapshotIdentifier

string

param DBSnapshotIdentifier

A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

type SnapshotType

string

param SnapshotType

The type of snapshots to be returned. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

• public - Return all DB snapshots that have been marked as public.

• awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .

type Filters

list

param Filters

A filter that specifies one or more DB snapshots to describe.

Supported filters:

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

• db-snapshot-id - Accepts DB snapshot identifiers.

• dbi-resource-id - Accepts identifiers of source DB instances.

• snapshot-type - Accepts types of DB snapshots.

• engine - Accepts names of database engines.

• (dict) --

  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

  Note

  Currently, wildcards are not supported in filters.

  The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions

  • Name (string) -- [REQUIRED]

    The name of the filter. Filter names are case-sensitive.

  • Values (list) -- [REQUIRED]

    One or more filter values. Filter values are case-sensitive.

    • (string) --

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

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

type IncludeShared

boolean

param IncludeShared

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

This setting doesn't apply to RDS Custom.

type IncludePublic

boolean

param IncludePublic

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

This setting doesn't apply to RDS Custom.

type DbiResourceId

string

param DbiResourceId

A specific DB resource ID to describe.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBSnapshots': [
        {
            'DBSnapshotIdentifier': 'string',
            'DBInstanceIdentifier': 'string',
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'Engine': 'string',
            'AllocatedStorage': 123,
            'Status': 'string',
            'Port': 123,
            'AvailabilityZone': 'string',
            'VpcId': 'string',
            'InstanceCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'SnapshotType': 'string',
            'Iops': 123,
            'OptionGroupName': 'string',
            'PercentProgress': 123,
            'SourceRegion': 'string',
            'SourceDBSnapshotIdentifier': 'string',
            'StorageType': 'string',
            'TdeCredentialArn': 'string',
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'DBSnapshotArn': 'string',
            'Timezone': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'ProcessorFeatures': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'DbiResourceId': 'string',
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
            'SnapshotDatabaseTime': datetime(2015, 1, 1),
            'SnapshotTarget': 'string',
            'StorageThroughput': 123,
            'DBSystemId': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Contains the result of a successful invocation of the DescribeDBSnapshots 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 .

  • DBSnapshots (list) --

    A list of DBSnapshot instances.

    • (dict) --

      Contains the details of an Amazon RDS DB snapshot.

      This data type is used as a response element in the DescribeDBSnapshots action.

      • DBSnapshotIdentifier (string) --

        Specifies the identifier for the DB snapshot.

      • DBInstanceIdentifier (string) --

        Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

      • SnapshotCreateTime (datetime) --

        Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

      • Engine (string) --

        Specifies the name of the database engine.

      • AllocatedStorage (integer) --

        Specifies the allocated storage size in gibibytes (GiB).

      • Status (string) --

        Specifies the status of this DB snapshot.

      • Port (integer) --

        Specifies the port that the database engine was listening on at the time of the snapshot.

      • AvailabilityZone (string) --

        Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

      • VpcId (string) --

        Provides the VPC ID associated with the DB snapshot.

      • InstanceCreateTime (datetime) --

        Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

      • MasterUsername (string) --

        Provides the master username for the DB snapshot.

      • EngineVersion (string) --

        Specifies the version of the database engine.

      • LicenseModel (string) --

        License model information for the restored DB instance.

      • SnapshotType (string) --

        Provides the type of the DB snapshot.

      • Iops (integer) --

        Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

      • OptionGroupName (string) --

        Provides the option group name for the DB snapshot.

      • PercentProgress (integer) --

        The percentage of the estimated data that has been transferred.

      • SourceRegion (string) --

        The Amazon Web Services Region that the DB snapshot was created in or copied from.

      • SourceDBSnapshotIdentifier (string) --

        The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

      • StorageType (string) --

        Specifies the storage type associated with DB snapshot.

      • TdeCredentialArn (string) --

        The ARN from the key store with which to associate the instance for TDE encryption.

      • Encrypted (boolean) --

        Specifies whether the DB snapshot is encrypted.

      • KmsKeyId (string) --

        If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

        The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      • DBSnapshotArn (string) --

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

      • Timezone (string) --

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

      • IAMDatabaseAuthenticationEnabled (boolean) --

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

      • ProcessorFeatures (list) --

        The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

        • (dict) --

          Contains the processor features of a DB instance class.

          To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

          You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

          • CreateDBInstance

          • ModifyDBInstance

          • RestoreDBInstanceFromDBSnapshot

          • RestoreDBInstanceFromS3

          • RestoreDBInstanceToPointInTime

          You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

          In addition, you can use the following actions for DB instance class processor information:

          • DescribeDBInstances

          • DescribeDBSnapshots

          • DescribeValidDBInstanceModifications

          If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

          • You are accessing an Oracle DB instance.

          • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

          • The current number CPU cores and threads is set to a non-default value.

          For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

          • Name (string) --

            The name of the processor feature. Valid names are coreCount and threadsPerCore .

          • Value (string) --

            The value of a processor feature name.

      • DbiResourceId (string) --

        The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

      • TagList (list) --

        A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • (dict) --

          Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

          For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

          • Key (string) --

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

          • Value (string) --

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

      • OriginalSnapshotCreateTime (datetime) --

        Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

      • SnapshotDatabaseTime (datetime) --

        The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

        If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

      • SnapshotTarget (string) --

        Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

      • StorageThroughput (integer) --

        Specifies the storage throughput for the DB snapshot.

      • DBSystemId (string) --

        The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

{'DBSnapshot': {'DBSystemId': 'string'}}

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.

See also: AWS API Documentation

Request Syntax

client.modify_db_snapshot(
    DBSnapshotIdentifier='string',
    EngineVersion='string',
    OptionGroupName='string'
)

type DBSnapshotIdentifier

string

param DBSnapshotIdentifier

[REQUIRED]

The identifier of the DB snapshot to modify.

type EngineVersion

string

param EngineVersion

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

• 5.5.46 (supported for 5.1 DB snapshots)

Oracle

• 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)

• 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots)

• 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

• 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

• 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS .

type OptionGroupName

string

param OptionGroupName

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

rtype

dict

returns

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DbiResourceId': 'string',
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotDatabaseTime': datetime(2015, 1, 1),
        'SnapshotTarget': 'string',
        'StorageThroughput': 123,
        'DBSystemId': 'string'
    }
}

Response Structure

• (dict) --

  • DBSnapshot (dict) --

    Contains the details of an Amazon RDS DB snapshot.

    This data type is used as a response element in the DescribeDBSnapshots action.

    • DBSnapshotIdentifier (string) --

      Specifies the identifier for the DB snapshot.

    • DBInstanceIdentifier (string) --

      Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB snapshot.

    • Port (integer) --

      Specifies the port that the database engine was listening on at the time of the snapshot.

    • AvailabilityZone (string) --

      Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB snapshot.

    • InstanceCreateTime (datetime) --

      Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

    • MasterUsername (string) --

      Provides the master username for the DB snapshot.

    • EngineVersion (string) --

      Specifies the version of the database engine.

    • LicenseModel (string) --

      License model information for the restored DB instance.

    • SnapshotType (string) --

      Provides the type of the DB snapshot.

    • Iops (integer) --

      Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    • OptionGroupName (string) --

      Provides the option group name for the DB snapshot.

    • PercentProgress (integer) --

      The percentage of the estimated data that has been transferred.

    • SourceRegion (string) --

      The Amazon Web Services Region that the DB snapshot was created in or copied from.

    • SourceDBSnapshotIdentifier (string) --

      The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

    • StorageType (string) --

      Specifies the storage type associated with DB snapshot.

    • TdeCredentialArn (string) --

      The ARN from the key store with which to associate the instance for TDE encryption.

    • Encrypted (boolean) --

      Specifies whether the DB snapshot is encrypted.

    • KmsKeyId (string) --

      If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DBSnapshotArn (string) --

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

    • Timezone (string) --

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

    • IAMDatabaseAuthenticationEnabled (boolean) --

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

    • ProcessorFeatures (list) --

      The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

      • (dict) --

        Contains the processor features of a DB instance class.

        To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

        You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

        • CreateDBInstance

        • ModifyDBInstance

        • RestoreDBInstanceFromDBSnapshot

        • RestoreDBInstanceFromS3

        • RestoreDBInstanceToPointInTime

        You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

        In addition, you can use the following actions for DB instance class processor information:

        • DescribeDBInstances

        • DescribeDBSnapshots

        • DescribeValidDBInstanceModifications

        If you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:

        • You are accessing an Oracle DB instance.

        • Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

        • The current number CPU cores and threads is set to a non-default value.

        For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

        • Name (string) --

          The name of the processor feature. Valid names are coreCount and threadsPerCore .

        • Value (string) --

          The value of a processor feature name.

    • DbiResourceId (string) --

      The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    • TagList (list) --

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) --

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) --

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

        • Value (string) --

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

    • OriginalSnapshotCreateTime (datetime) --

      Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

    • SnapshotDatabaseTime (datetime) --

      The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

      If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

    • SnapshotTarget (string) --

      Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

    • StorageThroughput (integer) --

      Specifies the storage throughput for the DB snapshot.

    • DBSystemId (string) --

      The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.