[ aws . cloudhsmv2 ]

create-cluster

Description

Creates a new AWS CloudHSM cluster.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-cluster
--subnet-ids <value>
--hsm-type <value>
[--source-backup-id <value>]
[--tag-list <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--subnet-ids (list)

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.

(string)

Syntax:

"string" "string" ...

--hsm-type (string)

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium .

--source-backup-id (string)

The identifier (ID) 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, use DescribeBackups .

--tag-list (list)

Tags to apply to the CloudHSM cluster during creation.

(structure)

Contains a tag. A tag is a key-value pair.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Cluster -> (structure)

Information about the cluster that was created.

BackupPolicy -> (string)

The cluster’s backup policy.

ClusterId -> (string)

The cluster’s identifier (ID).

CreateTimestamp -> (timestamp)

The date and time when the cluster was created.

Hsms -> (list)

Contains information about the HSMs in the cluster.

(structure)

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

AvailabilityZone -> (string)

The Availability Zone that contains the HSM.

ClusterId -> (string)

The identifier (ID) of the cluster that contains the HSM.

SubnetId -> (string)

The subnet that contains the HSM’s elastic network interface (ENI).

EniId -> (string)

The identifier (ID) of the HSM’s elastic network interface (ENI).

EniIp -> (string)

The IP address of the HSM’s elastic network interface (ENI).

HsmId -> (string)

The HSM’s identifier (ID).

State -> (string)

The HSM’s state.

StateMessage -> (string)

A description of the HSM’s state.

HsmType -> (string)

The type of HSM that the cluster contains.

PreCoPassword -> (string)

The default password for the cluster’s Pre-Crypto Officer (PRECO) user.

SecurityGroup -> (string)

The identifier (ID) of the cluster’s security group.

SourceBackupId -> (string)

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

State -> (string)

The cluster’s state.

StateMessage -> (string)

A description of the cluster’s state.

SubnetMapping -> (map)

A map from availability zone to the cluster’s subnet in that availability zone.

key -> (string)

value -> (string)

VpcId -> (string)

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Certificates -> (structure)

Contains one or more certificates or a certificate signing request (CSR).

ClusterCsr -> (string)

The cluster’s certificate signing request (CSR). The CSR exists only when the cluster’s state is UNINITIALIZED .

HsmCertificate -> (string)

The HSM certificate issued (signed) by the HSM hardware.

AwsHardwareCertificate -> (string)

The HSM hardware certificate issued (signed) by AWS CloudHSM.

ManufacturerHardwareCertificate -> (string)

The HSM hardware certificate issued (signed) by the hardware manufacturer.

ClusterCertificate -> (string)

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster’s owner.

TagList -> (list)

The list of tags for the cluster.

(structure)

Contains a tag. A tag is a key-value pair.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.