software.amazon.awscdk.services.ec2

Class CfnKeyPair

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnKeyPair

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:54.911Z")
public class CfnKeyPair
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::KeyPair`.

Specifies a key pair for an Amazon EC2 instance. The key pair can either be imported or created by Amazon EC2, as follows:

• To import an existing key pair, include the PublicKeyMaterial property in the template.
• To have Amazon EC2 create a new key pair, omit the PublicKeyMaterial property. When Amazon EC2 creates a new key pair, the private key is saved to an AWS Systems Manager Parameter Store. The name of the Systems Manager parameter follows the format /ec2/keypair/{key_pair_id} . For more information, see AWS Systems Manager Parameter Store in the AWS Systems Manager User Guide .

For more information, see Amazon EC2 key pairs in the Amazon EC2 User Guide .

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
         .keyType("keyType")
         .publicKeyMaterial("publicKeyMaterial")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnKeyPair(Construct scope, java.lang.String id, CfnKeyPairProps props) Create a new `AWS::EC2::KeyPair`.
protected	CfnKeyPair(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKeyPair(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrKeyFingerprint() If you created the key pair using Amazon EC2:.
java.lang.String	getAttrKeyPairId() The ID of the key pair.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getKeyName() A unique name for the key pair.
java.lang.String	getKeyType() The type of key pair.
java.lang.String	getPublicKeyMaterial() The public key material.
TagManager	getTags() The tags to apply to the key pair.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setKeyName(java.lang.String value) A unique name for the key pair.
void	setKeyType(java.lang.String value) The type of key pair.
void	setPublicKeyMaterial(java.lang.String value) The public key material.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnKeyPair

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

CfnKeyPair

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

CfnKeyPair

public CfnKeyPair(Construct scope,
                  java.lang.String id,
                  CfnKeyPairProps props)

Create a new `AWS::EC2::KeyPair`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrKeyFingerprint

public java.lang.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

public java.lang.String getAttrKeyPairId()

The ID of the key pair.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to apply to the key pair.

getKeyName

public java.lang.String getKeyName()

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

setKeyName

public void setKeyName(java.lang.String value)

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

getKeyType

public java.lang.String getKeyType()

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

setKeyType

public void setKeyType(java.lang.String value)

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

getPublicKeyMaterial

public java.lang.String getPublicKeyMaterial()

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.

setPublicKeyMaterial

public void setPublicKeyMaterial(java.lang.String value)

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.