AWS Fundamentals Logo
AWS Fundamentals
AWS::EKS::Nodegroup

EKS Nodegroup

Resource schema for AWS::EKS::Nodegroup

Properties

19 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
ClusterName
string
RequiredCreate-only
NodeRole
string
RequiredCreate-only
Subnets
Array<string>
RequiredCreate-only
AmiType
string
Create-only
CapacityType
string
Create-only
DiskSize
integer
Create-only
ForceUpdateEnabled
boolean
Write-only
InstanceTypes
Array<string>
Create-only
Labels
object
LaunchTemplate
LaunchTemplateSpecification
NodegroupName
string
Create-only
NodeRepairConfig
NodeRepairConfig
ReleaseVersion
string
RemoteAccess
RemoteAccess
Create-only
ScalingConfig
ScalingConfig
Tags
object
Taints
Array<Taint>
UpdateConfig
UpdateConfig
Version
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
Idstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EKS::Nodegroup

Resources:
  MyResource:
    Type: AWS::EKS::Nodegroup
    Properties:
      ClusterName: "my-clustername"
      NodeRole: "value"
      Subnets: []
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

eks:CreateNodegroupeks:DescribeNodegroupeks:TagResourceec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeSecurityGroupsec2:DescribeKeyPairsec2:CreateTags

read

eks:DescribeNodegroup

delete

eks:DeleteNodegroupeks:DescribeNodegroup

list

eks:ListNodegroups

update

iam:GetRoleiam:PassRoleeks:DescribeNodegroupeks:DescribeUpdateeks:ListUpdateseks:TagResourceeks:UntagResourceeks:UpdateNodegroupConfig

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceEKS
Properties21
Required3
TaggingSupported
Primary IDId

Supported Operations

CreateReadDeleteListUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

CapacityTypeNodegroupNameRemoteAccessNodeRoleClusterNameInstanceTypesDiskSizeAmiTypeSubnets

Related Resources

External Links