You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudHSM::Types::CreateHsmRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateHsmRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  subnet_id: "SubnetId", # required
  ssh_key: "SshKey", # required
  eni_ip: "IpAddress",
  iam_role_arn: "IamRoleArn", # required
  external_id: "ExternalId",
  subscription_type: "PRODUCTION", # required, accepts PRODUCTION
  client_token: "ClientToken",
  syslog_ip: "IpAddress",
}

Contains the inputs for the CreateHsm operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

Returns:

  • (String) —

    A user-defined token to ensure idempotence.

#eni_ip ⇒ String

The IP address to assign to the HSM\'s ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

Returns:

  • (String) —

    The IP address to assign to the HSM\'s ENI.

#external_id ⇒ String

The external ID from IamRoleArn, if present.

Returns:

  • (String) —

    The external ID from IamRoleArn, if present.

#iam_role_arn ⇒ String

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

Returns:

  • (String) —

    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

#ssh_key ⇒ String

The SSH public key to install on the HSM.

Returns:

  • (String) —

    The SSH public key to install on the HSM.

#subnet_id ⇒ String

The identifier of the subnet in your VPC in which to place the HSM.

Returns:

  • (String) —

    The identifier of the subnet in your VPC in which to place the HSM.

#subscription_type ⇒ String

Specifies the type of subscription for the HSM.

  • PRODUCTION - The HSM is being used in a production environment.

  • TRIAL - The HSM is being used in a product trial.

Possible values:

  • PRODUCTION

Returns:

  • (String) —

    Specifies the type of subscription for the HSM.

    • PRODUCTION - The HSM is being used in a production environment.

    • TRIAL - The HSM is being used in a product trial.

    .

#syslog_ip ⇒ String

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Returns:

  • (String) —

    The IP address for the syslog monitoring server.