AWS::Transfer::HostKey

Transfer HostKey

Resource type definition for AWS::Transfer::HostKey

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`ServerId`	`string`	RequiredCreate-only
`Description`	`string`
`HostKeyBody`	`string`	Create-onlyWrite-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The unique Amazon Resource Name (ARN) for the host key.
`DateImported`	`string`	The date on which the host key was added to the server.
`HostKeyFingerprint`	`string`	The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.
`HostKeyId`	`string`	A unique identifier for the host key.
`Type`	`string`	The encryption algorithm that is used for the host key.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Transfer::HostKey

Resources:
  MyResource:
    Type: AWS::Transfer::HostKey
    Properties:
      ServerId: "my-serverid"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

transfer:ImportHostKeytransfer:DescribeHostKeytransfer:TagResource

read

transfer:DescribeHostKeytransfer:ListTagsForResource

update

transfer:UpdateHostKeytransfer:DescribeHostKeytransfer:TagResourcetransfer:UntagResourcetransfer:ListTagsForResource

delete

transfer:DeleteHostKeytransfer:DescribeHostKeytransfer:ListTagsForResource

list

transfer:ListHostKeys

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceTransfer

Properties9

Required1

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ServerIdHostKeyBody

Related Resources

External Links

AWS Documentation