Package software.amazon.awscdk.services.ec2

Enum LocalStorage

java.lang.Object

java.lang.Enum<LocalStorage>

software.amazon.awscdk.services.ec2.LocalStorage

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-01T17:46:52.495Z")
@Stability(Stable)
public enum LocalStorage
extends Enum<LocalStorage>

Local storage support requirements for EC2 instances.

Controls whether selected instance types must, may, or must not include directly attached local storage (instance store).

Example:

 Role infrastructureRole;
 InstanceProfile instanceProfile;
 Vpc vpc;
 ManagedInstancesCapacityProvider miCapacityProvider = ManagedInstancesCapacityProvider.Builder.create(this, "MICapacityProvider")
         .infrastructureRole(infrastructureRole)
         .ec2InstanceProfile(instanceProfile)
         .subnets(vpc.getPrivateSubnets())
         .instanceRequirements(InstanceRequirementsConfig.builder()
                 // Required: CPU and memory constraints
                 .vCpuCountMin(2)
                 .vCpuCountMax(8)
                 .memoryMin(Size.gibibytes(4))
                 .memoryMax(Size.gibibytes(32))
                 // CPU preferences
                 .cpuManufacturers(List.of(CpuManufacturer.INTEL, CpuManufacturer.AMD))
                 .instanceGenerations(List.of(InstanceGeneration.CURRENT))
                 // Instance type filtering
                 .allowedInstanceTypes(List.of("m5.*", "c5.*"))
                 // Performance characteristics
                 .burstablePerformance(BurstablePerformance.EXCLUDED)
                 .bareMetal(BareMetal.EXCLUDED)
                 // Accelerator requirements (for ML/AI workloads)
                 .acceleratorTypes(List.of(AcceleratorType.GPU))
                 .acceleratorManufacturers(List.of(AcceleratorManufacturer.NVIDIA))
                 .acceleratorNames(List.of(AcceleratorName.T4, AcceleratorName.V100))
                 .acceleratorCountMin(1)
                 // Storage requirements
                 .localStorage(LocalStorage.REQUIRED)
                 .localStorageTypes(List.of(LocalStorageType.SSD))
                 .totalLocalStorageGBMin(100)
                 // Network requirements
                 .networkInterfaceCountMin(2)
                 .networkBandwidthGbpsMin(10)
                 // Cost optimization
                 .onDemandMaxPricePercentageOverLowestPrice(10)
                 .build())
         .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
EXCLUDED	Instance types with local storage are disallowed.
INCLUDED	Instance types with local storage are allowed, but types without local storage may also be selected.
REQUIRED	Only instance types with local storage are allowed.

Method Summary

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

INCLUDED

@Stability(Stable)
public static final LocalStorage INCLUDED

Instance types with local storage are allowed, but types without local storage may also be selected.

REQUIRED

@Stability(Stable)
public static final LocalStorage REQUIRED

Only instance types with local storage are allowed.

Types without local storage will be excluded.

EXCLUDED

@Stability(Stable)
public static final LocalStorage EXCLUDED

Instance types with local storage are disallowed.

Only types without local storage may be selected.

Method Details

values

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