Class: Aws::Transfer::Types::DescribedHostKey

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::DescribedHostKey

Defined in:

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

Overview

The details for a server host key.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The unique Amazon Resource Name (ARN) for the host key.

• #date_imported ⇒ Time

  The date on which the host key was added to the server.

• #description ⇒ String

  The text description for this host key.

• #host_key_fingerprint ⇒ String

  The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

• #host_key_id ⇒ String

  A unique identifier for the host key.

• #secret_id ⇒ String

  The ARN of the Secrets Manager secret that stores the host key material, when StorageType is SECRETS_MANAGER.

• #storage_type ⇒ String

  Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).

• #tags ⇒ Array<Types::Tag>

  Key-value pairs that can be used to group and search for host keys.

• #type ⇒ String

  The encryption algorithm that is used for the host key.

Instance Attribute Details

#arn ⇒ String

The unique Amazon Resource Name (ARN) for the host key.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#date_imported ⇒ Time

The date on which the host key was added to the server.

Returns:

• (Time)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The text description for this host key.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#host_key_fingerprint ⇒ String

The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#host_key_id ⇒ String

A unique identifier for the host key.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_id ⇒ String

The ARN of the Secrets Manager secret that stores the host key material, when StorageType is SECRETS_MANAGER.

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

Specifies whether the host key is stored by Transfer Family (SERVICE_MANAGED) or in Secrets Manager (SECRETS_MANAGER).

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Key-value pairs that can be used to group and search for host keys.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

• ssh-rsa

• ssh-ed25519

• ecdsa-sha2-nistp256

• ecdsa-sha2-nistp384

• ecdsa-sha2-nistp521

Returns:

• (String)

# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2985

class DescribedHostKey < Struct.new(
  :arn,
  :host_key_id,
  :host_key_fingerprint,
  :description,
  :type,
  :date_imported,
  :tags,
  :storage_type,
  :secret_id)
  SENSITIVE = []
  include Aws::Structure
end