Skip to content

DBClusterSnapshot

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

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

engine: NotRequired[String]

Specifies the name of the database engine.

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

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.