Package software.amazon.awscdk.services.eks

Enum TaintEffect

java.lang.Object

java.lang.Enum<TaintEffect>

software.amazon.awscdk.services.eks.TaintEffect

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:57.346Z")
@Stability(Stable)
public enum TaintEffect
extends Enum<TaintEffect>

Effect types of kubernetes node taint.

Note: These values are specifically for AWS EKS NodeGroups and use the AWS API format. When using AWS CLI or API, taint effects must be NO_SCHEDULE, PREFER_NO_SCHEDULE, or NO_EXECUTE. When using Kubernetes directly or kubectl, taint effects must be NoSchedule, PreferNoSchedule, or NoExecute.

For Kubernetes manifests (like Karpenter NodePools), use string literals with PascalCase format:

• 'NoSchedule' instead of TaintEffect.NO_SCHEDULE
• 'PreferNoSchedule' instead of TaintEffect.PREFER_NO_SCHEDULE
• 'NoExecute' instead of TaintEffect.NO_EXECUTE

Example:

 Cluster cluster;
 cluster.addNodegroupCapacity("custom-node-group", NodegroupOptions.builder()
         .instanceTypes(List.of(new InstanceType("m5.large")))
         .taints(List.of(TaintSpec.builder()
                 .effect(TaintEffect.NO_SCHEDULE)
                 .key("foo")
                 .value("bar")
                 .build()))
         .build());
 

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html

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
NO_EXECUTE	NoExecute.
NO_SCHEDULE	NoSchedule.
PREFER_NO_SCHEDULE	PreferNoSchedule.

Method Summary

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

NO_SCHEDULE

@Stability(Stable)
public static final TaintEffect NO_SCHEDULE

NoSchedule.

PREFER_NO_SCHEDULE

@Stability(Stable)
public static final TaintEffect PREFER_NO_SCHEDULE

PreferNoSchedule.

NO_EXECUTE

@Stability(Stable)
public static final TaintEffect NO_EXECUTE

NoExecute.

Method Details

values

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