Creates a managed node group for an Amazon EKS cluster.
See https://www.paws-r-sdk.com/docs/eks_create_nodegroup/ for full documentation.
eks_create_nodegroup(
clusterName,
nodegroupName,
scalingConfig = NULL,
diskSize = NULL,
subnets,
instanceTypes = NULL,
amiType = NULL,
remoteAccess = NULL,
nodeRole,
labels = NULL,
taints = NULL,
tags = NULL,
clientRequestToken = NULL,
launchTemplate = NULL,
updateConfig = NULL,
capacityType = NULL,
version = NULL,
releaseVersion = NULL
)
[required] The name of your cluster.
[required] The unique name to give your node group.
The scaling configuration details for the Auto Scaling group that is created for your node group.
The root device disk size (in GiB) for your node group instances. The
default disk size is 20 GiB for Linux and Bottlerocket. The default disk
size is 50 GiB for Windows. 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
Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
[required] The subnets to use for the Auto Scaling group that is created for your
node group. 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 Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
Specify the instance types for a node group. If you specify a GPU
instance type, make sure to also specify an applicable GPU AMI type with
the amiType
parameter. If you specify launchTemplate
, then you can
specify zero or one instance type in your launch template or you can
specify 0-20 instance types for instanceTypes
. If however, you specify
an instance type in your launch template and specify any
instanceTypes
, the node group deployment will fail. If you don't
specify an instance type in a launch template or for instanceTypes
,
then t3.medium
is used, by default. If you specify Spot
for
capacityType
, then we recommend specifying multiple values for
instanceTypes
. For more information, see Managed node group capacity types
and Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
The AMI type for your node group. If you specify launchTemplate
, and
your launch template uses a custom AMI, then don't specify amiType
, or
the node group deployment will fail. If your launch template uses a
Windows custom AMI, then add eks:kube-proxy-windows
to your Windows
nodes rolearn
in the aws-auth
ConfigMap
. For more information
about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
The remote access configuration to use with your node group. For Linux,
the protocol is SSH. For Windows, the protocol is RDP. 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 Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
[required] 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
Amazon Web Services APIs on your behalf. Nodes receive permissions for
these API calls through an IAM instance profile and associated policies.
Before you can launch nodes and register them into a cluster, you must
create an IAM role for those nodes to use when they are launched. For
more information, see Amazon EKS 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 Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
The Kubernetes labels
to apply to the nodes in the node group when
they are created.
The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
An object representing a node group's launch template specification.
When using this object, don't directly specify instanceTypes
,
diskSize
, or remoteAccess
. Make sure that the launch template meets
the requirements in launchTemplateSpecification
. Also refer to
Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
The node group update configuration.
The capacity type for your node group.
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 Customizing managed nodes with launch templates
in the Amazon EKS User Guide.
The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
If you specify launchTemplate
, and your launch template uses a custom
AMI, then don't specify releaseVersion
, or the node group deployment
will fail. For more information about using launch templates with Amazon
EKS, see Customizing managed nodes with launch templates
in the Amazon EKS User Guide.