Class: Aws::CloudHSM::Types::DescribeHsmResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudHSM::Types::DescribeHsmResponse

Defined in:

gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb

Overview

Contains the output of the DescribeHsm operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone ⇒ String

  The Availability Zone that the HSM is in.

• #eni_id ⇒ String

  The identifier of the elastic network interface (ENI) attached to the HSM.

• #eni_ip ⇒ String

  The IP address assigned to the HSM's ENI.

• #hsm_arn ⇒ String

  The ARN of the HSM.

• #hsm_type ⇒ String

  The HSM model type.

• #iam_role_arn ⇒ String

  The ARN of the IAM role assigned to the HSM.

• #partitions ⇒ Array<String>

  The list of partitions on the HSM.

• #serial_number ⇒ String

  The serial number of the HSM.

• #server_cert_last_updated ⇒ String

  The date and time that the server certificate was last updated.

• #server_cert_uri ⇒ String

  The URI of the certificate server.

• #software_version ⇒ String

  The HSM software version.

• #ssh_key_last_updated ⇒ String

  The date and time that the SSH key was last updated.

• #ssh_public_key ⇒ String

  The public SSH key.

• #status ⇒ String

  The status of the HSM.

• #status_details ⇒ String

  Contains additional information about the status of the HSM.

• #subnet_id ⇒ String

  The identifier of the subnet that the HSM is in.

• #subscription_end_date ⇒ String

  The subscription end date.

• #subscription_start_date ⇒ String

  The subscription start date.

• #subscription_type ⇒ String

  Specifies the type of subscription for the HSM.

• #vendor_name ⇒ String

  The name of the HSM vendor.

• #vpc_id ⇒ String

  The identifier of the VPC that the HSM is in.

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone that the HSM is in.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#eni_id ⇒ String

The identifier of the elastic network interface (ENI) attached to the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#eni_ip ⇒ String

The IP address assigned to the HSM's ENI.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#hsm_arn ⇒ String

The ARN of the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#hsm_type ⇒ String

The HSM model type.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

The ARN of the IAM role assigned to the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#partitions ⇒ Array<String>

The list of partitions on the HSM.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#serial_number ⇒ String

The serial number of the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#server_cert_last_updated ⇒ String

The date and time that the server certificate was last updated.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#server_cert_uri ⇒ String

The URI of the certificate server.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#software_version ⇒ String

The HSM software version.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_key_last_updated ⇒ String

The date and time that the SSH key was last updated.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_public_key ⇒ String

The public SSH key.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#status_details ⇒ String

Contains additional information about the status of the HSM.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

The identifier of the subnet that the HSM is in.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_end_date ⇒ String

The subscription end date.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#subscription_start_date ⇒ String

The subscription start date.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#vendor_name ⇒ String

The name of the HSM vendor.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The identifier of the VPC that the HSM is in.

Returns:

• (String)

# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 465

class DescribeHsmResponse < Struct.new(
  :hsm_arn,
  :status,
  :status_details,
  :availability_zone,
  :eni_id,
  :eni_ip,
  :subscription_type,
  :subscription_start_date,
  :subscription_end_date,
  :vpc_id,
  :subnet_id,
  :iam_role_arn,
  :serial_number,
  :vendor_name,
  :hsm_type,
  :software_version,
  :ssh_public_key,
  :ssh_key_last_updated,
  :server_cert_uri,
  :server_cert_last_updated,
  :partitions)
  SENSITIVE = []
  include Aws::Structure
end