CfnNodegroupProps
- class aws_cdk.aws_eks.CfnNodegroupProps(*, cluster_name, node_role, subnets, ami_type=None, capacity_type=None, disk_size=None, force_update_enabled=None, instance_types=None, labels=None, launch_template=None, nodegroup_name=None, node_repair_config=None, release_version=None, remote_access=None, scaling_config=None, tags=None, taints=None, update_config=None, version=None)
Bases:
object
Properties for defining a
CfnNodegroup
.- Parameters:
cluster_name (
str
) – The name of your cluster.node_role (
str
) – The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker nodekubelet
daemon makes calls to AWS 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 specifylaunchTemplate
, then don’t specify[IamInstanceProfile](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)
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 .subnets (
Sequence
[str
]) –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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)
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 .ami_type (
Optional
[str
]) –The AMI type for your node group. If you specify
launchTemplate
, and your launch template uses a custom AMI, then don’t specifyamiType
, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then addeks:kube-proxy-windows
to your Windows nodesrolearn
in theaws-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 .capacity_type (
Optional
[str
]) – The capacity type of your managed node group.disk_size (
Union
[int
,float
,None
]) –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 specifydiskSize
, 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 .force_update_enabled (
Union
[bool
,IResolvable
,None
]) – Force the update if anyPod
on the existing node group can’t be drained due to aPod
disruption budget issue. If an update fails because all Pods can’t be drained, you can force the update after it fails to terminate the old node whether or not anyPod
is running on the node. Default: - falseinstance_types (
Optional
[Sequence
[str
]]) –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 specifylaunchTemplate
, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types forinstanceTypes
. If however, you specify an instance type in your launch template and specify anyinstanceTypes
, the node group deployment will fail. If you don’t specify an instance type in a launch template or forinstanceTypes
, thent3.medium
is used, by default. If you specifySpot
forcapacityType
, then we recommend specifying multiple values forinstanceTypes
. For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in the Amazon EKS User Guide .labels (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The Kuberneteslabels
applied to the nodes in the node group. .. epigraph:: Onlylabels
that are applied with the Amazon EKS API are shown here. There may be other Kuberneteslabels
applied to the nodes in this group.launch_template (
Union
[IResolvable
,LaunchTemplateSpecificationProperty
,Dict
[str
,Any
],None
]) –An object representing a node group’s launch template specification. When using this object, don’t directly specify
instanceTypes
,diskSize
, orremoteAccess
. Make sure that the launch template meets the requirements inlaunchTemplateSpecification
. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .nodegroup_name (
Optional
[str
]) – The unique name to give your node group.node_repair_config (
Union
[IResolvable
,NodeRepairConfigProperty
,Dict
[str
,Any
],None
]) – The node auto repair configuration for the node group.release_version (
Optional
[str
]) – 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 . .. epigraph:: Changing this value triggers an update of the node group if one is available. You can’t update other properties at the same time as updatingRelease Version
.remote_access (
Union
[IResolvable
,RemoteAccessProperty
,Dict
[str
,Any
],None
]) –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 specifyremoteAccess
, 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 .scaling_config (
Union
[IResolvable
,ScalingConfigProperty
,Dict
[str
,Any
],None
]) – The scaling configuration details for the Auto Scaling group that is created for your node group.tags (
Optional
[Mapping
[str
,str
]]) – 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 AWS resources.taints (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,TaintProperty
,Dict
[str
,Any
]]],None
]) – The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one ofNo_Schedule
,Prefer_No_Schedule
, orNo_Execute
. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups .update_config (
Union
[IResolvable
,UpdateConfigProperty
,Dict
[str
,Any
],None
]) – The node group update configuration.version (
Optional
[str
]) – 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 specifylaunchTemplate
, and your launch template uses a custom AMI, then don’t specifyversion
, 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 . .. epigraph:: You can’t update other properties at the same time as updatingVersion
.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_eks as eks cfn_nodegroup_props = eks.CfnNodegroupProps( cluster_name="clusterName", node_role="nodeRole", subnets=["subnets"], # the properties below are optional ami_type="amiType", capacity_type="capacityType", disk_size=123, force_update_enabled=False, instance_types=["instanceTypes"], labels={ "labels_key": "labels" }, launch_template=eks.CfnNodegroup.LaunchTemplateSpecificationProperty( id="id", name="name", version="version" ), nodegroup_name="nodegroupName", node_repair_config=eks.CfnNodegroup.NodeRepairConfigProperty( enabled=False ), release_version="releaseVersion", remote_access=eks.CfnNodegroup.RemoteAccessProperty( ec2_ssh_key="ec2SshKey", # the properties below are optional source_security_groups=["sourceSecurityGroups"] ), scaling_config=eks.CfnNodegroup.ScalingConfigProperty( desired_size=123, max_size=123, min_size=123 ), tags={ "tags_key": "tags" }, taints=[eks.CfnNodegroup.TaintProperty( effect="effect", key="key", value="value" )], update_config=eks.CfnNodegroup.UpdateConfigProperty( max_unavailable=123, max_unavailable_percentage=123 ), version="version" )
Attributes
- ami_type
The AMI type for your node group.
If you specify
launchTemplate
, and your launch template uses a custom AMI, then don’t specifyamiType
, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then addeks:kube-proxy-windows
to your Windows nodesrolearn
in theaws-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 .
- capacity_type
The capacity type of your managed node group.
- cluster_name
The name of your cluster.
- disk_size
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 specifydiskSize
, 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 .
- force_update_enabled
Force the update if any
Pod
on the existing node group can’t be drained due to aPod
disruption budget issue.If an update fails because all Pods can’t be drained, you can force the update after it fails to terminate the old node whether or not any
Pod
is running on the node.
- instance_types
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 specifylaunchTemplate
, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types forinstanceTypes
. If however, you specify an instance type in your launch template and specify anyinstanceTypes
, the node group deployment will fail. If you don’t specify an instance type in a launch template or forinstanceTypes
, thent3.medium
is used, by default. If you specifySpot
forcapacityType
, then we recommend specifying multiple values forinstanceTypes
. For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in the Amazon EKS User Guide .
- labels
The Kubernetes
labels
applied to the nodes in the node group.Only
labels
that are applied with the Amazon EKS API are shown here. There may be other Kuberneteslabels
applied to the nodes in this group.
- launch_template
An object representing a node group’s launch template specification.
When using this object, don’t directly specify
instanceTypes
,diskSize
, orremoteAccess
. Make sure that the launch template meets the requirements inlaunchTemplateSpecification
. Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .
- node_repair_config
The node auto repair configuration for the node group.
- node_role
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. 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 specifylaunchTemplate
, then don’t specify[IamInstanceProfile](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)
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 .
- nodegroup_name
The unique name to give your node group.
- release_version
//docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html>`_ in the Amazon EKS User Guide .
Changing this value triggers an update of the node group if one is available. You can’t update other properties at the same time as updating
Release Version
.- See:
- Type:
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 <https
- remote_access
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 specifyremoteAccess
, 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 .
- scaling_config
The scaling configuration details for the Auto Scaling group that is created for your node group.
- subnets
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)
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 .
- tags
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 AWS resources.
- taints
The Kubernetes taints to be applied to the nodes in the node group when they are created.
Effect is one of
No_Schedule
,Prefer_No_Schedule
, orNo_Execute
. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups .
- update_config
The node group update configuration.
- 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 specifyversion
, 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 . .. epigraph:You can't update other properties at the same time as updating ``Version`` .