DocumentDB Cluster Snapshot

This table represents the DocumentDB Cluster Snapshot resource from Amazon Web Services.

aws.docdb_clustersnapshot

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
availability_zonescorearray<string>Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
cluster_create_timecoretimestampSpecifies the time when the cluster was created, in Universal Coordinated Time (UTC).
db_cluster_identifiercorestringSpecifies the cluster identifier of the cluster that this cluster snapshot was created from.
db_cluster_snapshot_arncorestringThe Amazon Resource Name (ARN) for the cluster snapshot.
db_cluster_snapshot_attributes_resultcorejson
db_cluster_snapshot_identifiercorestringSpecifies the identifier for the cluster snapshot.
enginecorestringSpecifies the name of the database engine.
engine_versioncorestringProvides the version of the database engine for this cluster snapshot.
kms_key_idcorestringIf <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for the encrypted cluster snapshot.
master_usernamecorestringProvides the master user name for the cluster snapshot.
percent_progresscoreint64Specifies the percentage of the estimated data that has been transferred.
portcoreint64Specifies the port that the cluster was listening on at the time of the snapshot.
snapshot_create_timecoretimestampProvides the time when the snapshot was taken, in UTC.
snapshot_typecorestringProvides the type of the cluster snapshot.
source_db_cluster_snapshot_arncorestringIf the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
statuscorestringSpecifies the status of this cluster snapshot.
storage_encryptedcoreboolSpecifies whether the cluster snapshot is encrypted.
storage_typecorestringStorage type associated with your cluster snapshot For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>. Valid values for storage type - <code>standard | iopt1</code> Default value is <code>standard </code>
tagscorehstore
vpc_idcorestringProvides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.