Skip to content

RDS  >  Structures  >  DBSnapshot

DBSnapshot

Structure Class

DBSnapshot dataclass

Bases: _SerdeShape

Contains the details of an Amazon RDS DB snapshot.

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

Attributes

additional_storage_volumes class-attribute instance-attribute
additional_storage_volumes: list[AdditionalStorageVolume] | None = ...

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 class-attribute instance-attribute
allocated_storage: int | None = ...

Specifies the allocated storage size in gibibytes (GiB).

availability_zone class-attribute instance-attribute
availability_zone: str | None = ...

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

backup_retention_period class-attribute instance-attribute
backup_retention_period: int | None = ...

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

db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

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

db_snapshot_arn class-attribute instance-attribute
db_snapshot_arn: str | None = ...

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

db_snapshot_identifier class-attribute instance-attribute
db_snapshot_identifier: str | None = ...

Specifies the identifier for the DB snapshot.

db_system_id class-attribute instance-attribute
db_system_id: str | None = ...

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 class-attribute instance-attribute
dbi_resource_id: str | None = ...

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 class-attribute instance-attribute
dedicated_log_volume: bool | None = ...

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

encrypted class-attribute instance-attribute
encrypted: bool | None = ...

Indicates whether the DB snapshot is encrypted.

engine class-attribute instance-attribute
engine: str | None = ...

Specifies the name of the database engine.

engine_version class-attribute instance-attribute
engine_version: str | None = ...

Specifies the version of the database engine.

full_snapshot_size_in_bytes class-attribute instance-attribute
full_snapshot_size_in_bytes: int | None = ...

The full size of the DB snapshot, in bytes.

Warning

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 class-attribute instance-attribute
iam_database_authentication_enabled: bool | None = ...

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

instance_create_time class-attribute instance-attribute
instance_create_time: datetime | None = ...

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

iops class-attribute instance-attribute
iops: int | None = ...

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

kms_key_id class-attribute instance-attribute
kms_key_id: str | None = ...

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 class-attribute instance-attribute
license_model: str | None = ...

License model information for the restored DB instance.

master_username class-attribute instance-attribute
master_username: str | None = ...

Provides the master username for the DB snapshot.

multi_tenant class-attribute instance-attribute
multi_tenant: bool | None = ...

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

option_group_name class-attribute instance-attribute
option_group_name: str | None = ...

Provides the option group name for the DB snapshot.

original_snapshot_create_time class-attribute instance-attribute
original_snapshot_create_time: datetime | None = ...

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

percent_progress class-attribute instance-attribute
percent_progress: int | None = ...

The percentage of the estimated data that has been transferred.

port class-attribute instance-attribute
port: int | None = ...

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

preferred_backup_window class-attribute instance-attribute
preferred_backup_window: str | None = ...

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

processor_features class-attribute instance-attribute
processor_features: list[ProcessorFeature] | None = ...

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 class-attribute instance-attribute
snapshot_availability_zone: str | None = ...

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 class-attribute instance-attribute
snapshot_create_time: datetime | None = ...

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

snapshot_database_time class-attribute instance-attribute
snapshot_database_time: datetime | None = ...

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 class-attribute instance-attribute
snapshot_target: str | None = ...

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

snapshot_type class-attribute instance-attribute
snapshot_type: str | None = ...

Provides the type of the DB snapshot.

source_db_snapshot_identifier class-attribute instance-attribute
source_db_snapshot_identifier: str | None = ...

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 class-attribute instance-attribute
source_region: str | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

Specifies the status of this DB snapshot.

storage_encryption_type class-attribute instance-attribute
storage_encryption_type: str | None = ...

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 class-attribute instance-attribute
storage_throughput: int | None = ...

Specifies the storage throughput for the DB snapshot.

storage_type class-attribute instance-attribute
storage_type: str | None = ...

Specifies the storage type associated with DB snapshot.

tag_list class-attribute instance-attribute
tag_list: list[Tag] | None = ...

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

tde_credential_arn class-attribute instance-attribute
tde_credential_arn: str | None = ...

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

timezone class-attribute instance-attribute
timezone: str | None = ...

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.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

Provides the VPC ID associated with the DB snapshot.