ClusterSnapshot ¶

class ClusterSnapshot(TypedDict, closed=True):
    subnet_ids: "capo_docdb_elastic.types.string_list.StringList"
    """<p>The Amazon EC2 subnet IDs for the elastic cluster.</p>"""
    snapshot_name: "str"
    """<p>The name of the elastic cluster snapshot.</p>"""
    snapshot_arn: "str"
    """<p>The ARN identifier of the elastic cluster snapshot.</p>"""
    snapshot_creation_time: "str"
    """<p>The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).</p>"""
    cluster_arn: "str"
    """<p>The ARN identifier of the elastic cluster.</p>"""
    cluster_creation_time: "str"
    """<p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>"""
    status: "capo_docdb_elastic.types.status.Status"
    """<p>The status of the elastic cluster snapshot.</p>"""
    vpc_security_group_ids: "capo_docdb_elastic.types.string_list.StringList"
    """<p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>"""
    admin_user_name: "str"
    """<p>The name of the elastic cluster administrator.</p>"""
    kms_key_id: "str"
    """<p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. </p>"""
    snapshot_type: NotRequired["capo_docdb_elastic.types.snapshot_type.SnapshotType"]
    """<p>The type of cluster snapshots to be returned. You can specify one of the following values:</p> <ul> <li> <p> <code>automated</code> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.</p> </li> <li> <p> <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p> </li> </ul>"""