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

Class: Aws::CloudHSM::Types::ModifyHsmRequest

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

Overview

Note:

When making an API call, you may pass ModifyHsmRequest data as a hash:

{
  hsm_arn: "HsmArn", # required
  subnet_id: "SubnetId",
  eni_ip: "IpAddress",
  iam_role_arn: "IamRoleArn",
  external_id: "ExternalId",
  syslog_ip: "IpAddress",
}

Contains the inputs for the ModifyHsm operation.

Instance Attribute Summary collapse

Instance Attribute Details

#eni_ipString

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end

#external_idString

The new external ID.

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end

#hsm_arnString

The ARN of the HSM to modify.

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end

#iam_role_arnString

The new IAM role ARN.

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end

#subnet_idString

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end

#syslog_ipString

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

Returns:

  • (String)


880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 880

class ModifyHsmRequest < Struct.new(
  :hsm_arn,
  :subnet_id,
  :eni_ip,
  :iam_role_arn,
  :external_id,
  :syslog_ip)
  include Aws::Structure
end