Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnKeyPairPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnKeyPairPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKeyPairPropsMixin>

Enclosing class:

CfnKeyPairPropsMixin

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

A fluent builder for CfnKeyPairPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnKeyPairPropsMixin	build()
static CfnKeyPairPropsMixin.Builder	create()
static CfnKeyPairPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnKeyPairPropsMixin.Builder	keyFormat(String keyFormat)	The format of the key pair.
CfnKeyPairPropsMixin.Builder	keyName(String keyName)	A unique name for the key pair.
CfnKeyPairPropsMixin.Builder	keyType(String keyType)	The type of key pair.
CfnKeyPairPropsMixin.Builder	publicKeyMaterial(String publicKeyMaterial)	The public key material.
CfnKeyPairPropsMixin.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 CfnKeyPairPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnKeyPairPropsMixin.Builder.

create

@Stability(Stable)
public static CfnKeyPairPropsMixin.Builder create()

Returns:

a new instance of CfnKeyPairPropsMixin.Builder.

keyFormat

@Stability(Stable)
public CfnKeyPairPropsMixin.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

keyName

@Stability(Stable)
public CfnKeyPairPropsMixin.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

keyType

@Stability(Stable)
public CfnKeyPairPropsMixin.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 CfnKeyPairPropsMixin.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 CfnKeyPairPropsMixin.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 CfnKeyPairPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnKeyPairPropsMixin.