DBSnapshot
¶
Source code in docs_src/capo_rds/types/db_snapshot.py
additional_storage_volumes
instance-attribute
¶
additional_storage_volumes: NotRequired[AdditionalStorageVolumesList]
The additional storage volumes associated with the DB snapshot. RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[Integer]
Specifies the allocated storage size in gibibytes (GiB).
availability_zone
instance-attribute
¶
availability_zone: NotRequired[String]
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
backup_retention_period
instance-attribute
¶
backup_retention_period: NotRequired[IntegerOptional]
The number of days for which automatic DB snapshots are retained.
db_instance_identifier
instance-attribute
¶
db_instance_identifier: NotRequired[String]
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
db_snapshot_arn
instance-attribute
¶
db_snapshot_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the DB snapshot.
db_snapshot_identifier
instance-attribute
¶
db_snapshot_identifier: NotRequired[String]
Specifies the identifier for the DB snapshot.
db_system_id
instance-attribute
¶
db_system_id: NotRequired[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.
dbi_resource_id
instance-attribute
¶
dbi_resource_id: NotRequired[String]
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
dedicated_log_volume
instance-attribute
¶
dedicated_log_volume: NotRequired[Boolean]
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
encrypted
instance-attribute
¶
encrypted: NotRequired[Boolean]
Indicates whether the DB snapshot is encrypted.
engine_version
instance-attribute
¶
engine_version: NotRequired[String]
Specifies the version of the database engine.
full_snapshot_size_in_bytes
instance-attribute
¶
full_snapshot_size_in_bytes: NotRequired[LongOptional]
The full size of the DB snapshot, in bytes.
This is not the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.
iam_database_authentication_enabled
instance-attribute
¶
iam_database_authentication_enabled: NotRequired[Boolean]
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
instance_create_time
instance-attribute
¶
instance_create_time: NotRequired[TStamp]
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
iops
instance-attribute
¶
iops: NotRequired[IntegerOptional]
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[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.
license_model
instance-attribute
¶
license_model: NotRequired[String]
License model information for the restored DB instance.
master_username
instance-attribute
¶
master_username: NotRequired[String]
Provides the master username for the DB snapshot.
multi_tenant
instance-attribute
¶
multi_tenant: NotRequired[BooleanOptional]
Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
option_group_name
instance-attribute
¶
option_group_name: NotRequired[String]
Provides the option group name for the DB snapshot.
original_snapshot_create_time
instance-attribute
¶
original_snapshot_create_time: NotRequired[TStamp]
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
percent_progress
instance-attribute
¶
percent_progress: NotRequired[Integer]
The percentage of the estimated data that has been transferred.
port
instance-attribute
¶
port: NotRequired[Integer]
Specifies the port that the database engine was listening on at the time of the snapshot.
preferred_backup_window
instance-attribute
¶
preferred_backup_window: NotRequired[String]
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
processor_features
instance-attribute
¶
processor_features: NotRequired[ProcessorFeatureList]
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.
snapshot_availability_zone
instance-attribute
¶
snapshot_availability_zone: NotRequired[String]
Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.
snapshot_create_time
instance-attribute
¶
snapshot_create_time: NotRequired[TStamp]
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
snapshot_database_time
instance-attribute
¶
snapshot_database_time: NotRequired[TStamp]
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.
snapshot_target
instance-attribute
¶
snapshot_target: NotRequired[String]
Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
snapshot_type
instance-attribute
¶
snapshot_type: NotRequired[String]
Provides the type of the DB snapshot.
source_db_snapshot_identifier
instance-attribute
¶
source_db_snapshot_identifier: NotRequired[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.
source_region
instance-attribute
¶
source_region: NotRequired[String]
The Amazon Web Services Region that the DB snapshot was created in or copied from.
storage_encryption_type
instance-attribute
¶
storage_encryption_type: NotRequired[StorageEncryptionType]
The type of encryption used to protect data at rest in the DB snapshot. Possible values:
-
none- The DB snapshot is not encrypted. -
sse-rds- The DB snapshot is encrypted using an Amazon Web Services owned KMS key. -
sse-kms- The DB snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
storage_throughput
instance-attribute
¶
storage_throughput: NotRequired[IntegerOptional]
Specifies the storage throughput for the DB snapshot.
storage_type
instance-attribute
¶
storage_type: NotRequired[String]
Specifies the storage type associated with DB snapshot.
tde_credential_arn
instance-attribute
¶
tde_credential_arn: NotRequired[String]
The ARN from the key store with which to associate the instance for TDE encryption.