Cluster ¶

class Cluster(TypedDict, closed=True):
    backup_policy: NotRequired["capo_cloudhsm_v2.types.backup_policy.BackupPolicy"]
    """<p>The cluster's backup policy.</p>"""
    backup_retention_policy: NotRequired[
        "capo_cloudhsm_v2.types.backup_retention_policy.BackupRetentionPolicy"
    ]
    """<p>A policy that defines how the service retains backups.</p>"""
    cluster_id: NotRequired["capo_cloudhsm_v2.types.cluster_id.ClusterId"]
    """<p>The cluster's identifier (ID).</p>"""
    create_timestamp: NotRequired["capo_cloudhsm_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the cluster was created.</p>"""
    hsms: NotRequired["capo_cloudhsm_v2.types.hsms.Hsms"]
    """<p>Contains information about the HSMs in the cluster.</p>"""
    hsm_type: NotRequired["capo_cloudhsm_v2.types.hsm_type.HsmType"]
    """<p>The type of HSM that the cluster contains.</p>"""
    hsm_type_rollback_expiration: NotRequired[
        "capo_cloudhsm_v2.types.timestamp.Timestamp"
    ]
    """<p>The timestamp until when the cluster can be rolled back to its original HSM type.</p>"""
    pre_co_password: NotRequired["capo_cloudhsm_v2.types.pre_co_password.PreCoPassword"]
    """<p>The default password for the cluster's Pre-Crypto Officer (PRECO) user.</p>"""
    security_group: NotRequired["capo_cloudhsm_v2.types.security_group.SecurityGroup"]
    """<p>The identifier (ID) of the cluster's security group.</p>"""
    source_backup_id: NotRequired["capo_cloudhsm_v2.types.backup_id.BackupId"]
    """<p>The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.</p>"""
    state: NotRequired["capo_cloudhsm_v2.types.cluster_state.ClusterState"]
    """<p>The cluster's state.</p>"""
    state_message: NotRequired["capo_cloudhsm_v2.types.state_message.StateMessage"]
    """<p>A description of the cluster's state.</p>"""
    subnet_mapping: NotRequired[
        "capo_cloudhsm_v2.types.external_subnet_mapping.ExternalSubnetMapping"
    ]
    """<p>A map from availability zone to the cluster’s subnet in that availability zone.</p>"""
    vpc_id: NotRequired["capo_cloudhsm_v2.types.vpc_id.VpcId"]
    """<p>The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.</p>"""
    network_type: NotRequired["capo_cloudhsm_v2.types.network_type.NetworkType"]
    """<p>The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.</p>"""
    certificates: NotRequired["capo_cloudhsm_v2.types.certificates.Certificates"]
    """<p>Contains one or more certificates or a certificate signing request (CSR).</p>"""
    tag_list: NotRequired["capo_cloudhsm_v2.types.tag_list.TagList"]
    """<p>The list of tags for the cluster.</p>"""
    mode: NotRequired["capo_cloudhsm_v2.types.cluster_mode.ClusterMode"]
    """<p>The mode of the cluster.</p>"""