CreateClusterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudhsm/json-schema/amazon-cloudhsm-create-cluster-request-schema.json",
  "title": "CreateClusterRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudhsm-cluster-api-openapi.yml#/components/schemas/CreateClusterRequest",
  "type": "object",
  "properties": {
    "BackupRetentionPolicy": {
      "$ref": "#/$defs/BackupRetentionPolicy"
    },
    "HsmType": {
      "type": "string",
      "description": "The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium."
    },
    "SourceBackupId": {
      "type": "string",
      "description": "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."
    },
    "SubnetIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "NetworkType": {
      "type": "string",
      "enum": [
        "IPV4",
        "DUALSTACK"
      ],
      "description": "The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK."
    },
    "TagList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "Tags to apply to the CloudHSM cluster during creation."
    },
    "Mode": {
      "type": "string",
      "enum": [
        "FIPS",
        "NON_FIPS"
      ],
      "description": "The mode to use in the cluster. The allowed values are FIPS and NON_FIPS."
    }
  },
  "required": [
    "HsmType",
    "SubnetIds"
  ],
  "$defs": {
    "BackupRetentionPolicy": {
      "type": "object",
      "properties": {
        "Type": {
          "type": "string",
          "enum": [
            "DAYS"
          ],
          "description": "The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups."
        },
        "Value": {
          "type": "string",
          "description": "Use a value between 7 - 379."
        }
      }
    },
    "Tag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The key of the tag."
        },
        "Value": {
          "type": "string",
          "description": "The value of the tag."
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    }
  }
}