DBClusterSnapshot
¶
Source code in docs_src/capo_docdb/types/db_cluster_snapshot.py
availability_zones
instance-attribute
¶
availability_zones: NotRequired[AvailabilityZones]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
cluster_create_time
instance-attribute
¶
cluster_create_time: NotRequired[TStamp]
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
db_cluster_identifier
instance-attribute
¶
db_cluster_identifier: NotRequired[String]
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
db_cluster_snapshot_arn
instance-attribute
¶
db_cluster_snapshot_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the cluster snapshot.
db_cluster_snapshot_identifier
instance-attribute
¶
db_cluster_snapshot_identifier: NotRequired[String]
Specifies the identifier for the cluster snapshot.
engine_version
instance-attribute
¶
engine_version: NotRequired[String]
Provides the version of the database engine for this cluster snapshot.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[String]
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
master_username
instance-attribute
¶
master_username: NotRequired[String]
Provides the master user name for the cluster snapshot.
percent_progress
instance-attribute
¶
percent_progress: NotRequired[Integer]
Specifies the percentage of the estimated data that has been transferred.
port
instance-attribute
¶
port: NotRequired[Integer]
Specifies the port that the cluster was listening on at the time of the snapshot.
snapshot_create_time
instance-attribute
¶
snapshot_create_time: NotRequired[TStamp]
Provides the time when the snapshot was taken, in UTC.
snapshot_type
instance-attribute
¶
snapshot_type: NotRequired[String]
Provides the type of the cluster snapshot.
source_db_cluster_snapshot_arn
instance-attribute
¶
source_db_cluster_snapshot_arn: NotRequired[String]
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
status
instance-attribute
¶
status: NotRequired[String]
Specifies the status of this cluster snapshot.
storage_encrypted
instance-attribute
¶
storage_encrypted: NotRequired[Boolean]
Specifies whether the cluster snapshot is encrypted.
storage_type
instance-attribute
¶
storage_type: NotRequired[String]
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard