Package software.amazon.awscdk.services.ec2

Enum KeyPairType

java.lang.Object

java.lang.Enum<KeyPairType>

software.amazon.awscdk.services.ec2.KeyPairType

All Implemented Interfaces:

Serializable, Comparable<KeyPairType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:00.960Z")
@Stability(Stable)
public enum KeyPairType
extends Enum<KeyPairType>

The type of the key pair.

Example:

 Vpc vpc;
 InstanceType instanceType;
 KeyPair keyPair = KeyPair.Builder.create(this, "KeyPair")
         .type(KeyPairType.ED25519)
         .format(KeyPairFormat.PEM)
         .build();
 Instance instance = Instance.Builder.create(this, "Instance")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(MachineImage.latestAmazonLinux2023())
         // Use the custom key pair
         .keyPair(keyPair)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ED25519	An ED25519 key.
RSA	An RSA key.

Method Summary

Modifier and Type	Method	Description
static KeyPairType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyPairType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RSA

@Stability(Stable)
public static final KeyPairType RSA

An RSA key.

ED25519

@Stability(Stable)
public static final KeyPairType ED25519

An ED25519 key.

Note that ED25519 keys are not supported for Windows instances.

Method Details

values

public static KeyPairType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyPairType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null