Package software.amazon.awscdk.services.ec2

Class CfnKeyPair

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnKeyPair
All Implemented Interfaces:
IInspectable, IKeyPairRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:18.916Z") @Stability(Stable) public class CfnKeyPair extends CfnResource implements IInspectable, IKeyPairRef, ITaggable
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.services.ec2.*;
 CfnKeyPair cfnKeyPair = CfnKeyPair.Builder.create(this, "MyCfnKeyPair")
         .keyName("keyName")
         // the properties below are optional
         .keyFormat("keyFormat")
         .keyType("keyType")
         .publicKeyMaterial("publicKeyMaterial")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnKeyPair

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

    • CfnKeyPair

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

    • CfnKeyPair

      @Stability(Stable) public CfnKeyPair(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnKeyPairProps props)
      Create a new AWS::EC2::KeyPair.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnKeyPair

      @Stability(Stable) @NotNull public static Boolean isCfnKeyPair(@NotNull Object x)
      Checks whether the given object is a CfnKeyPair.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrKeyFingerprint

      @Stability(Stable) @NotNull public String getAttrKeyFingerprint()
      If you created the key pair using Amazon EC2:.

      • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
      • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8 .

      If you imported the key pair to Amazon EC2:

      • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
      • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8 .

    • getAttrKeyPairId

      @Stability(Stable) @NotNull public String getAttrKeyPairId()
      The ID of the key pair.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getKeyPairRef

      @Stability(Stable) @NotNull public KeyPairReference getKeyPairRef()
      A reference to a KeyPair resource.
      Specified by:
      getKeyPairRef in interface IKeyPairRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getKeyName

      @Stability(Stable) @NotNull public String getKeyName()
      A unique name for the key pair.

    • setKeyName

      @Stability(Stable) public void setKeyName(@NotNull String value)
      A unique name for the key pair.

    • getKeyFormat

      @Stability(Stable) @Nullable public String getKeyFormat()
      The format of the key pair.

    • setKeyFormat

      @Stability(Stable) public void setKeyFormat(@Nullable String value)
      The format of the key pair.

    • getKeyType

      @Stability(Stable) @Nullable public String getKeyType()
      The type of key pair.

      Note that ED25519 keys are not supported for Windows instances.

    • setKeyType

      @Stability(Stable) public void setKeyType(@Nullable String value)
      The type of key pair.

      Note that ED25519 keys are not supported for Windows instances.

    • getPublicKeyMaterial

      @Stability(Stable) @Nullable public String getPublicKeyMaterial()
      The public key material.

    • setPublicKeyMaterial

      @Stability(Stable) public void setPublicKeyMaterial(@Nullable String value)
      The public key material.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to apply to the key pair.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to apply to the key pair.