interface CfnHostKeyProps

Language	Type name
.NET	Amazon.CDK.AWS.Transfer.CfnHostKeyProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnHostKeyProps
Java	software.amazon.awscdk.services.transfer.CfnHostKeyProps
Python	aws_cdk.aws_transfer.CfnHostKeyProps
TypeScript	aws-cdk-lib » aws_transfer » CfnHostKeyProps

Properties for defining a CfnHostKey.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-hostkey.html

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

Name	Type	Description
serverId	string	The identifier of the server that contains the host key.
description?	string	The text description for this host key.
hostKeyBody?	string	The private key portion of an SSH key pair.
tags?	CfnTag[]	Key-value pairs that can be used to group and search for host keys.

---

serverId

Type: string

The identifier of the server that contains the host key.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-hostkey.html#cfn-transfer-hostkey-serverid

---

description?

Type: string (optional)

The text description for this host key.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-hostkey.html#cfn-transfer-hostkey-description

---

hostKeyBody?

Type: string (optional)

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-hostkey.html#cfn-transfer-hostkey-hostkeybody

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-hostkey.html#cfn-transfer-hostkey-tags