AWS::EKS::Nodegroup - AWS CloudFormation

AWS::EKS::Nodegroup

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::EKS::Nodegroup", "Properties" : { "AmiType" : String, "ClusterName" : String, "DiskSize" : Double, "ForceUpdateEnabled" : Boolean, "InstanceTypes" : [ String, ... ], "Labels" : Json, "LaunchTemplate" : LaunchTemplateSpecification, "NodegroupName" : String, "NodeRole" : String, "ReleaseVersion" : String, "RemoteAccess" : RemoteAccess, "ScalingConfig" : ScalingConfig, "Subnets" : [ String, ... ], "Tags" : Json, "Version" : String } }

YAML

Type: AWS::EKS::Nodegroup Properties: AmiType: String ClusterName: String DiskSize: Double ForceUpdateEnabled: Boolean InstanceTypes: - String Labels: Json LaunchTemplate: LaunchTemplateSpecification NodegroupName: String NodeRole: String ReleaseVersion: String RemoteAccess: RemoteAccess ScalingConfig: ScalingConfig Subnets: - String Tags: Json Version: String

Properties

AmiType

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: No

Type: String

Allowed values: AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU

Update requires: Replacement

ClusterName

The name of the cluster to create the node group in.

Required: Yes

Type: String

Update requires: Replacement

DiskSize

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. If you specify launchTemplate, then don't specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: No

Type: Double

Update requires: Replacement

ForceUpdateEnabled

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

Required: No

Type: Boolean

Update requires: No interruption

InstanceTypes

The instance type to use for your node group. You can specify a single instance type for a node group. The default value for instanceTypes is t3.medium. If you choose a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate, then don't specify instanceTypes, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: No

Type: List of String

Update requires: Replacement

Labels

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Required: No

Type: Json

Update requires: No interruption

LaunchTemplate

An object representing a node group's launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

Required: No

Type: LaunchTemplateSpecification

Update requires: No interruption

NodegroupName

The unique name to give your node group.

Required: No

Type: String

Update requires: Replacement

NodeRole

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the Amazon EKS User Guide . If you specify launchTemplate, then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: Yes

Type: String

Update requires: Replacement

ReleaseVersion

The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD). By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.

Note

Changing this value triggers an update of the node group if one is available. However, only the latest available AMI release version is valid as an input. You cannot roll back to a previous AMI release version.

Required: No

Type: String

Update requires: No interruption

RemoteAccess

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate, then don't specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: No

Type: RemoteAccess

Update requires: Replacement

ScalingConfig

The scaling configuration details for the Auto Scaling group that is created for your node group.

Required: No

Type: ScalingConfig

Update requires: No interruption

Subnets

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster. If you specify launchTemplate, then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: Yes

Type: List of String

Update requires: Replacement

Tags

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Required: No

Type: Json

Update requires: No interruption

Version

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "myNodegroup" }

For the Amazon EKS node group myNodegroup, Ref returns the physical resource ID of the node group. For example, <cluster_name>/<nodegroup_name>.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) associated with the managed node group.

ClusterName

The name of the cluster that the managed node group resides in.

NodegroupName

The name associated with an Amazon EKS managed node group.

Examples

Create a managed node group

The following example creates an Amazon EKS managed node group called standard in the prod cluster.

JSON

{ "Resources": { "EKSNodegroup": { "Type": "AWS::EKS::Nodegroup", "Properties": { "ClusterName": "prod", "NodeRole": "arn:aws:iam::012345678910:role/eksInstanceRole", "ScalingConfig": { "MinSize": 3, "DesiredSize": 5, "MaxSize": 7 }, "Labels": { "Key1": "Value1", "Key2": "Value2" }, "Subnets": [ "subnet-6782e71e", "subnet-e7e761ac" ] } } } }

YAML

Resources: EKSNodegroup: Type: 'AWS::EKS::Nodegroup' Properties: ClusterName: prod NodeRole: 'arn:aws:iam::012345678910:role/eksInstanceRole' ScalingConfig: MinSize: 3 DesiredSize: 5 MaxSize: 7 Labels: Key1: Value1 Key2: Value2 Subnets: - subnet-6782e71e - subnet-e7e761ac

See also