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

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

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

Overview

Contains the output of the DescribeHsm operation.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone that the HSM is in.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#eni_idString

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

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#eni_ipString

The IP address assigned to the HSM's ENI.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#hsm_arnString

The ARN of the HSM.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#hsm_typeString

The HSM model type.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#iam_role_arnString

The ARN of the IAM role assigned to the HSM.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#partitionsArray<String>

The list of partitions on the HSM.

Returns:

  • (Array<String>)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#serial_numberString

The serial number of the HSM.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#server_cert_last_updatedString

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

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#server_cert_uriString

The URI of the certificate server.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#software_versionString

The HSM software version.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#ssh_key_last_updatedString

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

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#ssh_public_keyString

The public SSH key.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#statusString

The status of the HSM.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#status_detailsString

Contains additional information about the status of the HSM.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#subnet_idString

The identifier of the subnet that the HSM is in.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#subscription_end_dateString

The subscription end date.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#subscription_start_dateString

The subscription start date.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  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)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#vendor_nameString

The name of the HSM vendor.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end

#vpc_idString

The identifier of the VPC that the HSM is in.

Returns:

  • (String)


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/types.rb', line 500

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)
  include Aws::Structure
end