Skip to content

CreateClusterRequest

Source code in docs_src/capo_cloudhsm_v2/types/create_cluster_request.py
class CreateClusterRequest(TypedDict, closed=True):
    backup_retention_policy: NotRequired[
        "capo_cloudhsm_v2.types.backup_retention_policy.BackupRetentionPolicy"
    ]
    """<p>A policy that defines how the service retains backups.</p>"""
    hsm_type: "capo_cloudhsm_v2.types.hsm_type.HsmType"
    """<p>The type of HSM to use in the cluster. The allowed values are <code>hsm1.medium</code> and <code>hsm2m.medium</code>.</p>"""
    source_backup_id: NotRequired["capo_cloudhsm_v2.types.backup_arn.BackupArn"]
    """<p>The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use <a>DescribeBackups</a>. <i>If using a backup in another account, the full ARN must be supplied.</i> </p>"""
    subnet_ids: "capo_cloudhsm_v2.types.subnet_ids.SubnetIds"
    """<p>The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:</p> <ul> <li> <p>All subnets must be in the same virtual private cloud (VPC).</p> </li> <li> <p>You can specify only one subnet per Availability Zone.</p> </li> </ul>"""
    network_type: NotRequired["capo_cloudhsm_v2.types.network_type.NetworkType"]
    """<p>The NetworkType to create a cluster with. The allowed values are <code>IPV4</code> and <code>DUALSTACK</code>. </p>"""
    tag_list: NotRequired["capo_cloudhsm_v2.types.tag_list.TagList"]
    """<p>Tags to apply to the CloudHSM cluster during creation.</p>"""
    mode: NotRequired["capo_cloudhsm_v2.types.cluster_mode.ClusterMode"]
    """<p>The mode to use in the cluster. The allowed values are <code>FIPS</code> and <code>NON_FIPS</code>.</p>"""

backup_retention_policy instance-attribute

backup_retention_policy: NotRequired[BackupRetentionPolicy]

A policy that defines how the service retains backups.

hsm_type instance-attribute

hsm_type: HsmType

The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

mode instance-attribute

mode: NotRequired[ClusterMode]

The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

network_type instance-attribute

network_type: NotRequired[NetworkType]

The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.

source_backup_id instance-attribute

source_backup_id: NotRequired[BackupArn]

The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

subnet_ids instance-attribute

subnet_ids: SubnetIds

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

  • All subnets must be in the same virtual private cloud (VPC).

  • You can specify only one subnet per Availability Zone.

tag_list instance-attribute

tag_list: NotRequired[TagList]

Tags to apply to the CloudHSM cluster during creation.