View a markdown version of this page

DescribedHostKey - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribedHostKey

The details for a server host key.

Contents

Arn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: Yes

DateImported

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

Type: Timestamp

Required: No

Description

The text description for this host key.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [\p{Print}]*

Required: No

HostKeyFingerprint

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

Type: String

Required: No

HostKeyId

A unique identifier for the host key.

Type: String

Length Constraints: Fixed length of 25.

Pattern: hostkey-[0-9a-f]{17}

Required: No

SecretId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

StorageType

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

Type: String

Valid Values: SERVICE_MANAGED | SECRETS_MANAGER

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Type

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: