Package software.amazon.awscdk.services.ec2

Enum KeyPairFormat

java.lang.Object

java.lang.Enum<KeyPairFormat>

software.amazon.awscdk.services.ec2.KeyPairFormat

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:58.411Z")
@Stability(Stable)
public enum KeyPairFormat
extends Enum<KeyPairFormat>

The format 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
PEM	A PEM file.
PPK	A PPK file, typically used with PuTTY.

Method Summary

Modifier and Type	Method	Description
static KeyPairFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyPairFormat[]	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

PPK

@Stability(Stable)
public static final KeyPairFormat PPK

A PPK file, typically used with PuTTY.

PEM

@Stability(Stable)
public static final KeyPairFormat PEM

A PEM file.

Method Details

values

public static KeyPairFormat[] 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 KeyPairFormat 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