DBClusterSnapshot ¶

class DBClusterSnapshot(TypedDict, closed=True):
    availability_zones: NotRequired[
        "capo_rds.types.availability_zones.AvailabilityZones"
    ]
    """<p>The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.</p>"""
    db_cluster_snapshot_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier for the DB cluster snapshot.</p>"""
    db_cluster_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.</p>"""
    snapshot_create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when the snapshot was taken, in Universal Coordinated Time (UTC).</p>"""
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the database engine for this DB cluster snapshot.</p>"""
    engine_mode: NotRequired["capo_rds.types.string.String"]
    """<p>The engine mode of the database engine for this DB cluster snapshot.</p>"""
    allocated_storage: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The allocated storage size of the DB cluster snapshot in gibibytes (GiB).</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of this DB cluster snapshot. Valid statuses are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>copying</code> </p> </li> <li> <p> <code>creating</code> </p> </li> </ul>"""
    port: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The port that the DB cluster was listening on at the time of the snapshot.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>The VPC ID associated with the DB cluster snapshot.</p>"""
    cluster_create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"""
    master_username: NotRequired["capo_rds.types.string.String"]
    """<p>The master username for this DB cluster snapshot.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the database engine for this DB cluster snapshot.</p>"""
    license_model: NotRequired["capo_rds.types.string.String"]
    """<p>The license model information for this DB cluster snapshot.</p>"""
    snapshot_type: NotRequired["capo_rds.types.string.String"]
    """<p>The type of the DB cluster snapshot.</p>"""
    percent_progress: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The percentage of the estimated data that has been transferred.</p>"""
    storage_encrypted: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB cluster snapshot is encrypted.</p>"""
    storage_encryption_type: NotRequired[
        "capo_rds.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>The type of encryption used to protect data at rest in the DB cluster snapshot. Possible values:</p> <ul> <li> <p> <code>none</code> - The DB cluster snapshot is not encrypted.</p> </li> <li> <p> <code>sse-rds</code> - The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key.</p> </li> <li> <p> <code>sse-kms</code> - The DB cluster snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.</p> </li> </ul>"""
    backup_retention_period: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days for which automatic DB snapshots are retained.</p>"""
    preferred_backup_window: NotRequired["capo_rds.types.string.String"]
    """<p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.</p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>If <code>StorageEncrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"""
    db_cluster_snapshot_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the DB cluster snapshot.</p>"""
    source_db_cluster_snapshot_arn: NotRequired["capo_rds.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_rds.types.boolean.Boolean"]
    """<p>Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type associated with the DB cluster snapshot.</p> <p>This setting is only for Aurora DB clusters.</p>"""
    storage_throughput: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.</p> <p>This setting is only for non-Aurora Multi-AZ DB clusters.</p>"""
    db_cluster_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The resource ID of the DB cluster that this DB cluster snapshot was created from.</p>"""
    db_system_id: NotRequired["capo_rds.types.string.String"]
    """<p>Reserved for future use.</p>"""