Package software.amazon.awscdk.services.transfer

Class CfnHostKey.Builder

java.lang.Object

software.amazon.awscdk.services.transfer.CfnHostKey.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnHostKey>

Enclosing class:

CfnHostKey

@Stability(Stable)
public static final class CfnHostKey.Builder
extends Object
implements software.amazon.jsii.Builder<CfnHostKey>

A fluent builder for CfnHostKey.

Method Summary

Modifier and Type	Method	Description
CfnHostKey	build()
static CfnHostKey.Builder	create(software.constructs.Construct scope, String id)
CfnHostKey.Builder	description(String description)	The text description for this host key.
CfnHostKey.Builder	hostKeyBody(String hostKeyBody)	The private key portion of an SSH key pair.
CfnHostKey.Builder	serverId(String serverId)	The identifier of the server that contains the host key.
CfnHostKey.Builder	tags(List<? extends CfnTag> tags)	Key-value pairs that can be used to group and search for host keys.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnHostKey.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnHostKey.Builder.

serverId

@Stability(Stable)
public CfnHostKey.Builder serverId(String serverId)

The identifier of the server that contains the host key.

Parameters:

serverId - The identifier of the server that contains the host key. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnHostKey.Builder description(String description)

The text description for this host key.

Parameters:

description - The text description for this host key. This parameter is required.

Returns:

this

See Also:

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

hostKeyBody

@Stability(Stable)
public CfnHostKey.Builder hostKeyBody(String hostKeyBody)

The private key portion of an SSH key pair.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Parameters:

hostKeyBody - The private key portion of an SSH key pair. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnHostKey.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - Key-value pairs that can be used to group and search for host keys. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnHostKey build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnHostKey>

Returns:

a newly built instance of CfnHostKey.