2022/08/23 - Amazon Relational Database Service - 1 new5 updated api methods
Changes RDS for Oracle supports Oracle Data Guard switchover and read replica backups.
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database. Issue this command in the AWS Region that hosts the current standby database.
See also: AWS API Documentation
Request Syntax
client.switchover_read_replica(
DBInstanceIdentifier='string'
)
string
[REQUIRED]
The DB instance identifier of the current standby database. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing Oracle read replica DB instance.
dict
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)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceToPointInTime
DBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active.
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstance
CreateDBInstanceReadReplica
DeleteDBInstance
ModifyDBInstance
RebootDBInstance
RestoreDBInstanceFromDBSnapshot
DBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
The status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid values:
IPV4
DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
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.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
(string) --
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
(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.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
(string) --
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
PENDING - the IAM role ARN is being associated with the DB instance.
INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A *CoIP *provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
{'DBSnapshot': {'SnapshotDatabaseTime': 'timestamp'}}
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'
)
string
[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
string
[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
string
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.
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.
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}_.:/=+\-@]*)$").
boolean
A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
string
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.
string
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.
string
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv.
dict
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'
}
}
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.
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. *** REVIEWERS 7/27: Switchover
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
{'DBSnapshot': {'SnapshotDatabaseTime': 'timestamp'}}
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'
},
]
)
string
[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
string
[REQUIRED]
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
Must match the identifier of an existing DBInstance.
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.
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}_.:/=+\-@]*)$").
dict
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'
}
}
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.
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. *** REVIEWERS 7/27: Switchover
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
{'DBSnapshot': {'SnapshotDatabaseTime': 'timestamp'}}
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'
)
string
[REQUIRED]
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
dict
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'
}
}
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.
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. *** REVIEWERS 7/27: Switchover
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
{'DBSnapshots': {'SnapshotDatabaseTime': 'timestamp'}}
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'
)
string
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.
string
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.
string
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. 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.
list
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.
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) --
integer
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.
string
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.
boolean
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.
boolean
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.
string
A specific DB resource ID to describe.
dict
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'
},
]
}
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.
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. *** REVIEWERS 7/27: Switchover
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
{'DBSnapshot': {'SnapshotDatabaseTime': 'timestamp'}}
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'
)
string
[REQUIRED]
The identifier of the DB snapshot to modify.
string
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
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.
string
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.
dict
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'
}
}
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.
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. *** REVIEWERS 7/27: Switchover
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.