software.amazon.awscdk.services.autoscaling

Enum TerminationPolicy

java.lang.Object

java.lang.Enum<TerminationPolicy>

software.amazon.awscdk.services.autoscaling.TerminationPolicy

All Implemented Interfaces:

Serializable, Comparable<TerminationPolicy>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.824Z")
 @Stability(value=Stable)
public enum TerminationPolicy
extends Enum<TerminationPolicy>

Specifies the termination criteria to apply before Amazon EC2 Auto Scaling chooses an instance for termination.

Example:

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         // ...
         .terminationPolicies(List.of(TerminationPolicy.OLDEST_INSTANCE, TerminationPolicy.DEFAULT))
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOCATION_STRATEGY Terminate instances in the Auto Scaling group to align the remaining instances to the allocation strategy for the type of instance that is terminating (either a Spot Instance or an On-Demand Instance).
CLOSEST_TO_NEXT_INSTANCE_HOUR Terminate instances that are closest to the next billing hour.
DEFAULT Terminate instances according to the default termination policy.
NEWEST_INSTANCE Terminate the newest instance in the group.
OLDEST_INSTANCE Terminate the oldest instance in the group.
OLDEST_LAUNCH_CONFIGURATION Terminate instances that have the oldest launch configuration.
OLDEST_LAUNCH_TEMPLATE Terminate instances that have the oldest launch template.

Method Summary

Modifier and Type	Method and Description
static TerminationPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static TerminationPolicy[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOCATION_STRATEGY

@Stability(value=Stable)
public static final TerminationPolicy ALLOCATION_STRATEGY

Terminate instances in the Auto Scaling group to align the remaining instances to the allocation strategy for the type of instance that is terminating (either a Spot Instance or an On-Demand Instance).

CLOSEST_TO_NEXT_INSTANCE_HOUR

@Stability(value=Stable)
public static final TerminationPolicy CLOSEST_TO_NEXT_INSTANCE_HOUR

Terminate instances that are closest to the next billing hour.

DEFAULT

@Stability(value=Stable)
public static final TerminationPolicy DEFAULT

Terminate instances according to the default termination policy.

NEWEST_INSTANCE

@Stability(value=Stable)
public static final TerminationPolicy NEWEST_INSTANCE

Terminate the newest instance in the group.

OLDEST_INSTANCE

@Stability(value=Stable)
public static final TerminationPolicy OLDEST_INSTANCE

Terminate the oldest instance in the group.

OLDEST_LAUNCH_CONFIGURATION

@Stability(value=Stable)
public static final TerminationPolicy OLDEST_LAUNCH_CONFIGURATION

Terminate instances that have the oldest launch configuration.

OLDEST_LAUNCH_TEMPLATE

@Stability(value=Stable)
public static final TerminationPolicy OLDEST_LAUNCH_TEMPLATE

Terminate instances that have the oldest launch template.

Method Detail

values

public static TerminationPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TerminationPolicy c : TerminationPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static TerminationPolicy 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