Skip to content

DBClusterSnapshot

Source code in docs_src/capo_neptune/types/db_cluster_snapshot.py
class DBClusterSnapshot(TypedDict, closed=True):
    availability_zones: NotRequired[
        "capo_neptune.types.availability_zones.AvailabilityZones"
    ]
    """<p>Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.</p>"""
    db_cluster_snapshot_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.</p> <p>After you restore a DB cluster using a <code>DBClusterSnapshotIdentifier</code>, you must specify the same <code>DBClusterSnapshotIdentifier</code> for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.</p> <p>However, if you don't specify the <code>DBClusterSnapshotIdentifier</code>, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the <code>DBClusterSnapshotIdentifier</code>, and the original DB cluster is deleted.</p>"""
    db_cluster_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.</p>"""
    snapshot_create_time: NotRequired["capo_neptune.types.t_stamp.TStamp"]
    """<p>Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).</p>"""
    engine: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the name of the database engine.</p>"""
    allocated_storage: NotRequired["capo_neptune.types.integer.Integer"]
    """<p>Specifies the allocated storage size in gibibytes (GiB).</p>"""
    status: NotRequired["capo_neptune.types.string.String"]
    """<p>Specifies the status of this DB cluster snapshot.</p>"""
    port: NotRequired["capo_neptune.types.integer.Integer"]
    """<p>Specifies the port that the DB cluster was listening on at the time of the snapshot.</p>"""
    vpc_id: NotRequired["capo_neptune.types.string.String"]
    """<p>Provides the VPC ID associated with the DB cluster snapshot.</p>"""
    cluster_create_time: NotRequired["capo_neptune.types.t_stamp.TStamp"]
    """<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"""
    master_username: NotRequired["capo_neptune.types.string.String"]
    """<p>Not supported by Neptune.</p>"""
    engine_version: NotRequired["capo_neptune.types.string.String"]
    """<p>Provides the version of the database engine for this DB cluster snapshot.</p>"""
    license_model: NotRequired["capo_neptune.types.string.String"]
    """<p>Provides the license model information for this DB cluster snapshot.</p>"""
    snapshot_type: NotRequired["capo_neptune.types.string.String"]
    """<p>Provides the type of the DB cluster snapshot.</p>"""
    percent_progress: NotRequired["capo_neptune.types.integer.Integer"]
    """<p>Specifies the percentage of the estimated data that has been transferred.</p>"""
    storage_encrypted: NotRequired["capo_neptune.types.boolean.Boolean"]
    """<p>Specifies whether the DB cluster snapshot is encrypted.</p>"""
    kms_key_id: NotRequired["capo_neptune.types.string.String"]
    """<p>If <code>StorageEncrypted</code> is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.</p>"""
    db_cluster_snapshot_arn: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB cluster snapshot.</p>"""
    source_db_cluster_snapshot_arn: NotRequired["capo_neptune.types.string.String"]
    """<p>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.</p>"""
    iam_database_authentication_enabled: NotRequired[
        "capo_neptune.types.boolean.Boolean"
    ]
    """<p>True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>"""
    storage_type: NotRequired["capo_neptune.types.string.String"]
    """<p>The storage type associated with the DB cluster snapshot.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[Integer]

Specifies the allocated storage size in gibibytes (GiB).

availability_zones instance-attribute

availability_zones: NotRequired[AvailabilityZones]

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

cluster_create_time instance-attribute

cluster_create_time: NotRequired[TStamp]

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[String]

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

db_cluster_snapshot_arn instance-attribute

db_cluster_snapshot_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the DB cluster snapshot.

db_cluster_snapshot_identifier instance-attribute

db_cluster_snapshot_identifier: NotRequired[String]

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

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 DB cluster snapshot.

iam_database_authentication_enabled instance-attribute

iam_database_authentication_enabled: NotRequired[Boolean]

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.

license_model instance-attribute

license_model: NotRequired[String]

Provides the license model information for this DB cluster snapshot.

master_username instance-attribute

master_username: NotRequired[String]

Not supported by Neptune.

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 DB 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 Universal Coordinated Time (UTC).

snapshot_type instance-attribute

snapshot_type: NotRequired[String]

Provides the type of the DB cluster snapshot.

source_db_cluster_snapshot_arn instance-attribute

source_db_cluster_snapshot_arn: NotRequired[String]

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

status: NotRequired[String]

Specifies the status of this DB cluster snapshot.

storage_encrypted instance-attribute

storage_encrypted: NotRequired[Boolean]

Specifies whether the DB cluster snapshot is encrypted.

storage_type instance-attribute

storage_type: NotRequired[String]

The storage type associated with the DB cluster snapshot.

vpc_id instance-attribute

vpc_id: NotRequired[String]

Provides the VPC ID associated with the DB cluster snapshot.