Skip to content

Create Cluster

cloudhsmv2_create_cluster R Documentation

Creates a new CloudHSM cluster

Description

Creates a new CloudHSM cluster.

Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.

Usage

cloudhsmv2_create_cluster(BackupRetentionPolicy, HsmType,
  SourceBackupId, SubnetIds, TagList, Mode)

Arguments

BackupRetentionPolicy

A policy that defines how the service retains backups.

HsmType

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

SourceBackupId

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 describe_backups. If using a backup in another account, the full ARN must be supplied.

SubnetIds

[required] 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.

TagList

Tags to apply to the CloudHSM cluster during creation.

Mode

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

Value

A list with the following syntax: 

list(
  Cluster = list(
    BackupPolicy = "DEFAULT",
    BackupRetentionPolicy = list(
      Type = "DAYS",
      Value = "string"
    ),
    ClusterId = "string",
    CreateTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Hsms = list(
      list(
        AvailabilityZone = "string",
        ClusterId = "string",
        SubnetId = "string",
        EniId = "string",
        EniIp = "string",
        HsmId = "string",
        State = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED",
        StateMessage = "string"
      )
    ),
    HsmType = "string",
    PreCoPassword = "string",
    SecurityGroup = "string",
    SourceBackupId = "string",
    State = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED",
    StateMessage = "string",
    SubnetMapping = list(
      "string"
    ),
    VpcId = "string",
    Certificates = list(
      ClusterCsr = "string",
      HsmCertificate = "string",
      AwsHardwareCertificate = "string",
      ManufacturerHardwareCertificate = "string",
      ClusterCertificate = "string"
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    Mode = "FIPS"|"NON_FIPS"
  )
)

Request syntax

svc$create_cluster(
  BackupRetentionPolicy = list(
    Type = "DAYS",
    Value = "string"
  ),
  HsmType = "string",
  SourceBackupId = "string",
  SubnetIds = list(
    "string"
  ),
  TagList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Mode = "FIPS"|"NON_FIPS"
)