CfnHostKeyProps

class aws_cdk.aws_transfer.CfnHostKeyProps(*, server_id, description=None, host_key_body=None, tags=None)

Bases: object

Properties for defining a CfnHostKey.

Parameters:

server_id (str) – The identifier of the server that contains the host key.
description (Optional[str]) – The text description for this host key.
host_key_body (Optional[str]) – The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs that can be used to group and search for host keys.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transfer as transfer

cfn_host_key_props = transfer.CfnHostKeyProps(
    server_id="serverId",

    # the properties below are optional
    description="description",
    host_key_body="hostKeyBody",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The text description for this host key.

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

host_key_body

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

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

server_id

The identifier of the server that contains the host key.

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

tags

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

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