Skip to content

DBSnapshot

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

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 instance-attribute

engine: NotRequired[String]

Specifies the name of the database engine.

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.

status instance-attribute

status: NotRequired[String]

Specifies the status of this DB snapshot.

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.

tag_list instance-attribute

tag_list: NotRequired[TagList]

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.

timezone instance-attribute

timezone: NotRequired[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.

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the VPC ID associated with the DB snapshot.