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, 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 the cluster to create the node group in.

  • node_role (str) – 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 specify launchTemplate , 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 Launch template support 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 Launch template support in the Amazon EKS User Guide .

  • ami_type (Optional[str]) –

    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 .

  • 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. 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 .

  • force_update_enabled (Union[bool, IResolvable, None]) – 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.

  • instance_types (Optional[Sequence[str]]) –

    Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU 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 Launch template support in the Amazon EKS User Guide .

  • labels (Optional[Any]) – The Kubernetes labels to be applied to the nodes in the node group when they are created.

  • launch_template (Union[IResolvable, LaunchTemplateSpecificationProperty, Dict[str, Any], None]) – 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 .

  • nodegroup_name (Optional[str]) – The unique name to give your 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. However, only the latest available AMI release version is valid as an input. You cannot roll back to a previous AMI release version.

  • remote_access (Union[IResolvable, RemoteAccessProperty, Dict[str, Any], None]) –

    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 .

  • 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[Any]) – The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

  • 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 of No_Schedule , Prefer_No_Schedule , or No_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 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 .

Link

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.
import aws_cdk.aws_eks as eks

# labels: Any
# tags: Any

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,
    launch_template=eks.CfnNodegroup.LaunchTemplateSpecificationProperty(
        id="id",
        name="name",
        version="version"
    ),
    nodegroup_name="nodegroupName",
    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,
    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.

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-amitype

Return type

Optional[str]

capacity_type

The capacity type of your managed node group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-capacitytype

Return type

Optional[str]

cluster_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-clustername

Return type

str

disk_size

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize

Return type

Union[int, float, None]

force_update_enabled

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled

Return type

Union[bool, IResolvable, None]

instance_types

Specify the instance types for a node group.

If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU 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 Launch template support in the Amazon EKS User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

Return type

Optional[List[str]]

labels

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels

Return type

Any

launch_template

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-launchtemplate

Return type

Union[IResolvable, LaunchTemplateSpecificationProperty, None]

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 specify launchTemplate , 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 Launch template support in the Amazon EKS User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderole

Return type

str

nodegroup_name

The unique name to give your node group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-nodegroupname

Return type

Optional[str]

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. However, only the latest available AMI release version is valid as an input. You cannot roll back to a previous AMI release version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-releaseversion

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

Return type

Optional[str]

remote_access

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess

Return type

Union[IResolvable, RemoteAccessProperty, None]

scaling_config

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig

Return type

Union[IResolvable, ScalingConfigProperty, None]

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 Launch template support in the Amazon EKS User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-subnets

Return type

List[str]

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. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-tags

Return type

Any

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 , or No_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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-taints

Return type

Union[IResolvable, List[Union[IResolvable, TaintProperty]], None]

update_config

The node group update configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-updateconfig

Return type

Union[IResolvable, UpdateConfigProperty, None]

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-version

Return type

Optional[str]