DBClusterSnapshot¶
Structure Class¶
DBClusterSnapshot
dataclass
¶
Bases: _SerdeShape
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots action.
Attributes¶
allocated_storage
class-attribute
instance-attribute
¶
allocated_storage: int | None = ...
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
availability_zones
class-attribute
instance-attribute
¶
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
backup_retention_period
class-attribute
instance-attribute
¶
backup_retention_period: int | None = ...
The number of days for which automatic DB snapshots are retained.
cluster_create_time
class-attribute
instance-attribute
¶
cluster_create_time: datetime | None = ...
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
db_cluster_identifier
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
db_cluster_resource_id
class-attribute
instance-attribute
¶
db_cluster_resource_id: str | None = ...
The resource ID of the DB cluster that this DB cluster snapshot was created from.
db_cluster_snapshot_arn
class-attribute
instance-attribute
¶
db_cluster_snapshot_arn: str | None = ...
The Amazon Resource Name (ARN) for the DB cluster snapshot.
db_cluster_snapshot_identifier
class-attribute
instance-attribute
¶
db_cluster_snapshot_identifier: str | None = ...
The identifier for the DB cluster snapshot.
db_system_id
class-attribute
instance-attribute
¶
db_system_id: str | None = ...
Reserved for future use.
engine
class-attribute
instance-attribute
¶
engine: str | None = ...
The name of the database engine for this DB cluster snapshot.
engine_mode
class-attribute
instance-attribute
¶
engine_mode: str | None = ...
The engine mode of the database engine for this DB cluster snapshot.
engine_version
class-attribute
instance-attribute
¶
engine_version: str | None = ...
The version of the database engine for this DB cluster snapshot.
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.
kms_key_id
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
If StorageEncrypted is true, the Amazon Web Services KMS key
identifier for the encrypted DB cluster 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 = ...
The license model information for this DB cluster snapshot.
master_username
class-attribute
instance-attribute
¶
master_username: str | None = ...
The master username for this DB cluster snapshot.
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 = ...
The port that the DB cluster 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.
snapshot_create_time
class-attribute
instance-attribute
¶
snapshot_create_time: datetime | None = ...
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshot_type
class-attribute
instance-attribute
¶
snapshot_type: str | None = ...
The type of the DB cluster snapshot.
source_db_cluster_snapshot_arn
class-attribute
instance-attribute
¶
source_db_cluster_snapshot_arn: str | None = ...
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The status of this DB cluster snapshot. Valid statuses are the following:
-
available -
copying -
creating
storage_encrypted
class-attribute
instance-attribute
¶
storage_encrypted: bool | None = ...
Specifies whether the DB cluster snapshot is encrypted with an Amazon Web Services managed key or a customer managed key.
If the DB cluster snapshot is encrypted with an Amazon Web Services
owned key, this value is false and StorageEncryptionType is
sse-rds. In that case, the data at rest is still encrypted. To
determine how the data at rest is protected, use
StorageEncryptionType.
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 cluster snapshot. Possible values:
-
none- The DB cluster snapshot is not encrypted. -
sse-rds- The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key. -
sse-kms- The DB cluster 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 = ...
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
storage_type
class-attribute
instance-attribute
¶
storage_type: str | None = ...
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
tag_list
class-attribute
instance-attribute
¶
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.