Package software.amazon.awscdk.services.ec2

Class CfnKeyPair.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnKeyPair.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKeyPair>

Enclosing class:

CfnKeyPair

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

A fluent builder for CfnKeyPair.

Method Summary

Modifier and Type	Method	Description
CfnKeyPair	build()
static CfnKeyPair.Builder	create(software.constructs.Construct scope, String id)
CfnKeyPair.Builder	keyFormat(String keyFormat)	The format of the key pair.
CfnKeyPair.Builder	keyName(String keyName)	A unique name for the key pair.
CfnKeyPair.Builder	keyType(String keyType)	The type of key pair.
CfnKeyPair.Builder	publicKeyMaterial(String publicKeyMaterial)	The public key material.
CfnKeyPair.Builder	tags(List<? extends CfnTag> tags)	The tags to apply to the key pair.

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 CfnKeyPair.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 CfnKeyPair.Builder.

keyName

@Stability(Stable)
public CfnKeyPair.Builder keyName(String keyName)

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

Parameters:

keyName - A unique name for the key pair. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyname

keyFormat

@Stability(Stable)
public CfnKeyPair.Builder keyFormat(String keyFormat)

The format of the key pair.

Default: pem

Default: - "pem"

Parameters:

keyFormat - The format of the key pair. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keyformat

keyType

@Stability(Stable)
public CfnKeyPair.Builder keyType(String keyType)

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

If the PublicKeyMaterial property is specified, the KeyType property is ignored, and the key type is inferred from the PublicKeyMaterial value.

Default: rsa

Default: - "rsa"

Parameters:

keyType - The type of key pair. Note that ED25519 keys are not supported for Windows instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-keytype

publicKeyMaterial

@Stability(Stable)
public CfnKeyPair.Builder publicKeyMaterial(String publicKeyMaterial)

The public key material.

The PublicKeyMaterial property is used to import a key pair. If this property is not specified, then a new key pair will be created.

Parameters:

publicKeyMaterial - The public key material. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-keypair.html#cfn-ec2-keypair-publickeymaterial

tags

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

The tags to apply to the key pair.

Parameters:

tags - The tags to apply to the key pair. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnKeyPair build()

Specified by:

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

Returns:

a newly built instance of CfnKeyPair.