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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudhsm/types.rb

Overview

Contains the inputs for the ‘CreateHsm` operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#eni_ipString

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)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#external_idString

The external ID from ‘IamRoleArn`, if present.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_keyString

The SSH public key to install on the HSM.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idString

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

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_typeString

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.

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end

#syslog_ipString

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

Returns:

  • (String)


142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/aws-sdk-cloudhsm/types.rb', line 142

class CreateHsmRequest < Struct.new(
  :subnet_id,
  :ssh_key,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :subscription_type,
  :client_token,
  :syslog_ip)
  SENSITIVE = []
  include Aws::Structure
end