Package software.amazon.awscdk.services.transfer

Interface CfnHostKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHostKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:20.655Z")
@Stability(Stable)
public interface CfnHostKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnHostKey.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnHostKeyProps cfnHostKeyProps = CfnHostKeyProps.builder()
         .serverId("serverId")
         // the properties below are optional
         .description("description")
         .hostKeyBody("hostKeyBody")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnHostKeyProps.Builder	A builder for CfnHostKeyProps
static final class	CfnHostKeyProps.Jsii$Proxy	An implementation for CfnHostKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnHostKeyProps.Builder	builder()
default String	getDescription()	The text description for this host key.
default String	getHostKeyBody()	The private key portion of an SSH key pair.
String	getServerId()	The identifier of the server that contains the host key.
default List<CfnTag>	getTags()	Key-value pairs that can be used to group and search for host keys.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getServerId

@Stability(Stable)
@NotNull
String getServerId()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

getHostKeyBody

@Stability(Stable)
@Nullable
default String getHostKeyBody()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnHostKeyProps.Builder builder()

Returns:

a CfnHostKeyProps.Builder of CfnHostKeyProps