View a markdown version of this page

AWS::Transfer::HostKey - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Transfer::HostKey

Adds a host key to the server that's specified by the ServerId parameter.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Transfer::HostKey",
  "Properties" : {
      "Description" : String,
      "HostKeyBody" : String,
      "KmsKey" : String,
      "ServerId" : String,
      "StorageType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Transfer::HostKey
Properties:
  Description: String
  HostKeyBody: String
  KmsKey: String
  ServerId: String
  StorageType: String
  Tags: 
    - Tag

Properties

Description

The text description for this host key.

Required: No

Type: String

Pattern: ^[\p{Print}]*$

Minimum: 0

Maximum: 200

Update requires: No interruption

HostKeyBody

The private key portion of an SSH key pair.

Amazon Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Required: No

Type: String

Maximum: 4096

Update requires: Replacement

KmsKey

Property description not available.

Required: No

Type: String

Pattern: ^arn:\S+$

Minimum: 20

Maximum: 1600

Update requires: No interruption

ServerId

The identifier of the server that contains the host key that you are importing.

Required: Yes

Type: String

Pattern: ^s-([0-9a-f]{17})$

Minimum: 19

Maximum: 19

Update requires: Replacement

StorageType

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

Required: No

Type: String

Allowed values: SERVICE_MANAGED | SECRETS_MANAGER

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

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

DateImported

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

HostKeyFingerprint

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

HostKeyId

A unique identifier for the host key.

SecretId

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

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