aws-cdk-lib.aws_transfer.CfnHostKeyProps

CfnHostKeyProps Struct

Properties for defining a CfnHostKey.

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const cfnHostKeyProps: transfer.CfnHostKeyProps = {
  serverId: 'serverId',

  // the properties below are optional
  description: 'description',
  hostKeyBody: 'hostKeyBody',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The text description for this host key.

hostKeyBodystringhost_key_bodystrhostKeyBodyStringHostKeyBodystringHostKeyBody*string#

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

serverIdstringserver_idstrserverIdStringServerIdstringServerId*stringrequired#

The identifier of the server that contains the host key.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

Used as props by

• CfnHostKey