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

Class CfnKeyPairPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

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

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.484Z")
@Stability(Stable)
public class CfnKeyPairPropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a key pair for use with an Amazon Elastic Compute Cloud instance as follows:.

• To import an existing key pair, include the PublicKeyMaterial property.
• To create a new key pair, omit the PublicKeyMaterial property.

When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. AWS CloudFormation does not create or return the private key material when you import a key pair.

When you create a new key pair, the private key is saved to AWS Systems Manager Parameter Store, using a parameter with the following name: /ec2/keypair/{key_pair_id} . For more information about retrieving private key, and the required permissions, see Create a key pair using CloudFormation in the Amazon EC2 User Guide .

When CloudFormation deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ec2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnKeyPairPropsMixin cfnKeyPairPropsMixin = CfnKeyPairPropsMixin.Builder.create(CfnKeyPairMixinProps.builder()
         .keyFormat("keyFormat")
         .keyName("keyName")
         .keyType("keyType")
         .publicKeyMaterial("publicKeyMaterial")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnKeyPairPropsMixin.Builder	A fluent builder for CfnKeyPairPropsMixin.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnKeyPairPropsMixin(CfnKeyPairMixinProps props)	Create a mixin to apply properties to AWS::EC2::KeyPair.
	CfnKeyPairPropsMixin(CfnKeyPairMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EC2::KeyPair.
protected	CfnKeyPairPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKeyPairPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnKeyPairMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnKeyPairPropsMixin

protected CfnKeyPairPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnKeyPairPropsMixin

protected CfnKeyPairPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnKeyPairPropsMixin

@Stability(Stable)
public CfnKeyPairPropsMixin(@NotNull
 CfnKeyPairMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EC2::KeyPair.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnKeyPairPropsMixin

@Stability(Stable)
public CfnKeyPairPropsMixin(@NotNull
 CfnKeyPairMixinProps props)

Create a mixin to apply properties to AWS::EC2::KeyPair.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnKeyPairMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()