Skip to content

docs(eks): clarify TaintEffect enum usage for AWS vs Kubernetes contexts #34781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 27, 2025
Merged

docs(eks): clarify TaintEffect enum usage for AWS vs Kubernetes contexts #34781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c0d2233
fix(nodegroup): update taint effect values to match expected casing
pahud Jun 20, 2025
69d792c
fix(nodegroup): update taint effect values to match expected casing
pahud Jun 21, 2025
a12dd40
docs(nodegroup): enhance TaintEffect documentation with usage notes a…
pahud Jun 21, 2025
c17396c
Merge branch 'main' into fix-34780
aemada-aws Jun 25, 2025
1daaf13
lint
pahud Aug 26, 2025
584cbb8
Merge branch 'main' into fix-34780
pahud Aug 26, 2025
fad3fe9
Merge branch 'main' into fix-34780
mergify[bot] Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions packages/@aws-cdk/aws-eks-v2-alpha/lib/managed-nodegroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,17 @@ export interface LaunchTemplateSpec {

/**
* 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
*
* @see https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html
*/
export enum TaintEffect {
/**
Expand Down
11 changes: 11 additions & 0 deletions packages/aws-cdk-lib/aws-eks/lib/managed-nodegroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,17 @@ export interface LaunchTemplateSpec {

/**
* 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
*
* @see https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html
*/
export enum TaintEffect {
/**
Expand Down
Loading