aws-cdk-lib.aws_eks.CfnNodegroup

CfnNodegroup L1 construct

Creates a managed 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 later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. For more information about using launch templates, see Customizing managed nodes with launch templates .

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. For more information, see Managed node groups in the Amazon EKS User Guide .

Windows AMI types are only supported for commercial AWS Regions that support Windows on Amazon EKS.

Construct›CfnElement›CfnRefElement›CfnResource›CfnNodegroup

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• INodegroupRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::EKS::Nodegroup

Source

Generated code

Type last changed

v2.252.0 · 30 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnNodegroup = new eks.CfnNodegroup(this, 'MyCfnNodegroup', {
  clusterName: 'clusterName',
  nodeRole: 'nodeRole',
  subnets: ['subnets'],

  // the properties below are optional
  amiType: 'amiType',
  capacityType: 'capacityType',
  diskSize: 123,
  forceUpdateEnabled: false,
  instanceTypes: ['instanceTypes'],
  labels: {
    labelsKey: 'labels',
  },
  launchTemplate: {
    id: 'id',
    name: 'name',
    version: 'version',
  },
  nodegroupName: 'nodegroupName',
  nodeRepairConfig: {
    enabled: false,
    maxParallelNodesRepairedCount: 123,
    maxParallelNodesRepairedPercentage: 123,
    maxUnhealthyNodeThresholdCount: 123,
    maxUnhealthyNodeThresholdPercentage: 123,
    nodeRepairConfigOverrides: [{
      minRepairWaitTimeMins: 123,
      nodeMonitoringCondition: 'nodeMonitoringCondition',
      nodeUnhealthyReason: 'nodeUnhealthyReason',
      repairAction: 'repairAction',
    }],
  },
  releaseVersion: 'releaseVersion',
  remoteAccess: {
    ec2SshKey: 'ec2SshKey',

    // the properties below are optional
    sourceSecurityGroups: ['sourceSecurityGroups'],
  },
  scalingConfig: {
    desiredSize: 123,
    maxSize: 123,
    minSize: 123,
  },
  tags: {
    tagsKey: 'tags',
  },
  taints: [{
    effect: 'effect',
    key: 'key',
    value: 'value',
  }],
  updateConfig: {
    maxUnavailable: 123,
    maxUnavailablePercentage: 123,
    updateStrategy: 'updateStrategy',
  },
  version: 'version',
  warmPoolConfig: {
    enabled: false,
    maxGroupPreparedCapacity: 123,
    minSize: 123,
    poolState: 'poolState',
    reuseOnScaleIn: false,
  },
});

# 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 = eks.CfnNodegroup(self, "MyCfnNodegroup",
    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,
        max_parallel_nodes_repaired_count=123,
        max_parallel_nodes_repaired_percentage=123,
        max_unhealthy_node_threshold_count=123,
        max_unhealthy_node_threshold_percentage=123,
        node_repair_config_overrides=[eks.CfnNodegroup.NodeRepairConfigOverridesProperty(
            min_repair_wait_time_mins=123,
            node_monitoring_condition="nodeMonitoringCondition",
            node_unhealthy_reason="nodeUnhealthyReason",
            repair_action="repairAction"
        )]
    ),
    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,
        update_strategy="updateStrategy"
    ),
    version="version",
    warm_pool_config=eks.CfnNodegroup.WarmPoolConfigProperty(
        enabled=False,
        max_group_prepared_capacity=123,
        min_size=123,
        pool_state="poolState",
        reuse_on_scale_in=False
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.eks.*;

CfnNodegroup cfnNodegroup = CfnNodegroup.Builder.create(this, "MyCfnNodegroup")
        .clusterName("clusterName")
        .nodeRole("nodeRole")
        .subnets(List.of("subnets"))

        // the properties below are optional
        .amiType("amiType")
        .capacityType("capacityType")
        .diskSize(123)
        .forceUpdateEnabled(false)
        .instanceTypes(List.of("instanceTypes"))
        .labels(Map.of(
                "labelsKey", "labels"))
        .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                .id("id")
                .name("name")
                .version("version")
                .build())
        .nodegroupName("nodegroupName")
        .nodeRepairConfig(NodeRepairConfigProperty.builder()
                .enabled(false)
                .maxParallelNodesRepairedCount(123)
                .maxParallelNodesRepairedPercentage(123)
                .maxUnhealthyNodeThresholdCount(123)
                .maxUnhealthyNodeThresholdPercentage(123)
                .nodeRepairConfigOverrides(List.of(NodeRepairConfigOverridesProperty.builder()
                        .minRepairWaitTimeMins(123)
                        .nodeMonitoringCondition("nodeMonitoringCondition")
                        .nodeUnhealthyReason("nodeUnhealthyReason")
                        .repairAction("repairAction")
                        .build()))
                .build())
        .releaseVersion("releaseVersion")
        .remoteAccess(RemoteAccessProperty.builder()
                .ec2SshKey("ec2SshKey")

                // the properties below are optional
                .sourceSecurityGroups(List.of("sourceSecurityGroups"))
                .build())
        .scalingConfig(ScalingConfigProperty.builder()
                .desiredSize(123)
                .maxSize(123)
                .minSize(123)
                .build())
        .tags(Map.of(
                "tagsKey", "tags"))
        .taints(List.of(TaintProperty.builder()
                .effect("effect")
                .key("key")
                .value("value")
                .build()))
        .updateConfig(UpdateConfigProperty.builder()
                .maxUnavailable(123)
                .maxUnavailablePercentage(123)
                .updateStrategy("updateStrategy")
                .build())
        .version("version")
        .warmPoolConfig(WarmPoolConfigProperty.builder()
                .enabled(false)
                .maxGroupPreparedCapacity(123)
                .minSize(123)
                .poolState("poolState")
                .reuseOnScaleIn(false)
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS;

var cfnNodegroup = new CfnNodegroup(this, "MyCfnNodegroup", new CfnNodegroupProps {
    ClusterName = "clusterName",
    NodeRole = "nodeRole",
    Subnets = new [] { "subnets" },

    // the properties below are optional
    AmiType = "amiType",
    CapacityType = "capacityType",
    DiskSize = 123,
    ForceUpdateEnabled = false,
    InstanceTypes = new [] { "instanceTypes" },
    Labels = new Dictionary<string, string> {
        { "labelsKey", "labels" }
    },
    LaunchTemplate = new LaunchTemplateSpecificationProperty {
        Id = "id",
        Name = "name",
        Version = "version"
    },
    NodegroupName = "nodegroupName",
    NodeRepairConfig = new NodeRepairConfigProperty {
        Enabled = false,
        MaxParallelNodesRepairedCount = 123,
        MaxParallelNodesRepairedPercentage = 123,
        MaxUnhealthyNodeThresholdCount = 123,
        MaxUnhealthyNodeThresholdPercentage = 123,
        NodeRepairConfigOverrides = new [] { new NodeRepairConfigOverridesProperty {
            MinRepairWaitTimeMins = 123,
            NodeMonitoringCondition = "nodeMonitoringCondition",
            NodeUnhealthyReason = "nodeUnhealthyReason",
            RepairAction = "repairAction"
        } }
    },
    ReleaseVersion = "releaseVersion",
    RemoteAccess = new RemoteAccessProperty {
        Ec2SshKey = "ec2SshKey",

        // the properties below are optional
        SourceSecurityGroups = new [] { "sourceSecurityGroups" }
    },
    ScalingConfig = new ScalingConfigProperty {
        DesiredSize = 123,
        MaxSize = 123,
        MinSize = 123
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    Taints = new [] { new TaintProperty {
        Effect = "effect",
        Key = "key",
        Value = "value"
    } },
    UpdateConfig = new UpdateConfigProperty {
        MaxUnavailable = 123,
        MaxUnavailablePercentage = 123,
        UpdateStrategy = "updateStrategy"
    },
    Version = "version",
    WarmPoolConfig = new WarmPoolConfigProperty {
        Enabled = false,
        MaxGroupPreparedCapacity = 123,
        MinSize = 123,
        PoolState = "poolState",
        ReuseOnScaleIn = false
    }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnNodegroup := awscdk.Aws_eks.NewCfnNodegroup(this, jsii.String("MyCfnNodegroup"), &CfnNodegroupProps{
	ClusterName: jsii.String("clusterName"),
	NodeRole: jsii.String("nodeRole"),
	Subnets: []interface{}{
		jsii.String("subnets"),
	},

	// the properties below are optional
	AmiType: jsii.String("amiType"),
	CapacityType: jsii.String("capacityType"),
	DiskSize: jsii.Number(123),
	ForceUpdateEnabled: jsii.Boolean(false),
	InstanceTypes: []*string{
		jsii.String("instanceTypes"),
	},
	Labels: map[string]*string{
		"labelsKey": jsii.String("labels"),
	},
	LaunchTemplate: &LaunchTemplateSpecificationProperty{
		Id: jsii.String("id"),
		Name: jsii.String("name"),
		Version: jsii.String("version"),
	},
	NodegroupName: jsii.String("nodegroupName"),
	NodeRepairConfig: &NodeRepairConfigProperty{
		Enabled: jsii.Boolean(false),
		MaxParallelNodesRepairedCount: jsii.Number(123),
		MaxParallelNodesRepairedPercentage: jsii.Number(123),
		MaxUnhealthyNodeThresholdCount: jsii.Number(123),
		MaxUnhealthyNodeThresholdPercentage: jsii.Number(123),
		NodeRepairConfigOverrides: []interface{}{
			&NodeRepairConfigOverridesProperty{
				MinRepairWaitTimeMins: jsii.Number(123),
				NodeMonitoringCondition: jsii.String("nodeMonitoringCondition"),
				NodeUnhealthyReason: jsii.String("nodeUnhealthyReason"),
				RepairAction: jsii.String("repairAction"),
			},
		},
	},
	ReleaseVersion: jsii.String("releaseVersion"),
	RemoteAccess: &RemoteAccessProperty{
		Ec2SshKey: jsii.String("ec2SshKey"),

		// the properties below are optional
		SourceSecurityGroups: []*string{
			jsii.String("sourceSecurityGroups"),
		},
	},
	ScalingConfig: &ScalingConfigProperty{
		DesiredSize: jsii.Number(123),
		MaxSize: jsii.Number(123),
		MinSize: jsii.Number(123),
	},
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
	Taints: []interface{}{
		&TaintProperty{
			Effect: jsii.String("effect"),
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	UpdateConfig: &UpdateConfigProperty{
		MaxUnavailable: jsii.Number(123),
		MaxUnavailablePercentage: jsii.Number(123),
		UpdateStrategy: jsii.String("updateStrategy"),
	},
	Version: jsii.String("version"),
	WarmPoolConfig: &WarmPoolConfigProperty{
		Enabled: jsii.Boolean(false),
		MaxGroupPreparedCapacity: jsii.Number(123),
		MinSize: jsii.Number(123),
		PoolState: jsii.String("poolState"),
		ReuseOnScaleIn: jsii.Boolean(false),
	},
})

Initializer

new CfnNodegroup(scope: Construct, id: string, props: CfnNodegroupProps)

CfnNodegroup(scope: Construct, id: str, props: CfnNodegroupProps)

new CfnNodegroup(Construct scope, String id, CfnNodegroupProps props)

new CfnNodegroup(Construct scope, string id, CfnNodegroupProps props)

NewCfnNodegroup(Scope Construct, Id *string, Props CfnNodegroupProps)

Construct Props

amiType?optionalstringami_type?optionalstramiType?optionalStringAmiType?optionalstringAmiType?optional*string#

The AMI type for your node group.

notes

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 .

capacityType?optionalstringcapacity_type?optionalstrcapacityType?optionalStringCapacityType?optionalstringCapacityType?optional*string#

The capacity type of your managed node group.

clusterNamestring | IClusterRefcluster_nametyping.Union[str, IClusterRef]clusterNameStringClusterNamestringClusterNameinterface{}required#

The name of your cluster.

diskSize?optionalnumberdisk_size?optionalint | floatdiskSize?optionalNumberDiskSize?optionaldoubleDiskSize?optional*float64#

The root device disk size (in GiB) for your node group instances.

notes

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 .

forceUpdateEnabled?optionalboolean | IResolvableforce_update_enabled?optionaltyping.Union[bool, IResolvable]forceUpdateEnabled?optionalBooleanForceUpdateEnabled?optionalboolForceUpdateEnabled?optionalinterface{}= false#

Force the update if any `Pod` on the existing node group can't be drained due to a `Pod` 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.

instanceTypes?optionalstring[]instance_types?optionaltyping.List[str]instanceTypes?optionalList<String>InstanceTypes?optionalstring[]InstanceTypes?optional*[]*string#

Specify the instance types for a node group.

notes

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 .

labels?optionalIResolvable | { [key: string]: string }labels?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]labels?optionalIResolvableLabels?optionalIResolvableLabels?optionalinterface{}#

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 Kubernetes labels applied to the nodes in this group.

launchTemplate?optionalIResolvable | CfnNodegroup.LaunchTemplateSpecificationPropertylaunch_template?optionaltyping.Union[IResolvable, LaunchTemplateSpecificationProperty]launchTemplate?optionalIResolvableLaunchTemplate?optionalIResolvableLaunchTemplate?optionalinterface{}#

An object representing a node group's launch template specification.

notes

When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . You cannot later specify a different launch template ID or name than what was used to create the node group.

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 .

nodegroupName?optionalstringnodegroup_name?optionalstrnodegroupName?optionalStringNodegroupName?optionalstringNodegroupName?optional*string#

The unique name to give your node group.

nodeRepairConfig?optionalIResolvable | CfnNodegroup.NodeRepairConfigPropertynode_repair_config?optionaltyping.Union[IResolvable, NodeRepairConfigProperty]nodeRepairConfig?optionalIResolvableNodeRepairConfig?optionalIResolvableNodeRepairConfig?optionalinterface{}#

The node auto repair configuration for the node group.

nodeRolestring | IRoleRefnode_roletyping.Union[str, IRoleRef]nodeRoleStringNodeRolestringNodeRoleinterface{}required#

The Amazon Resource Name (ARN) of the IAM role to associate with your node group.

notes

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

releaseVersion?optionalstringrelease_version?optionalstrreleaseVersion?optionalStringReleaseVersion?optionalstringReleaseVersion?optional*string#

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://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 .

remoteAccess?optionalIResolvable | CfnNodegroup.RemoteAccessPropertyremote_access?optionaltyping.Union[IResolvable, RemoteAccessProperty]remoteAccess?optionalIResolvableRemoteAccess?optionalIResolvableRemoteAccess?optionalinterface{}#

The remote access configuration to use with your node group.

notes

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 .

scalingConfig?optionalIResolvable | CfnNodegroup.ScalingConfigPropertyscaling_config?optionaltyping.Union[IResolvable, ScalingConfigProperty]scalingConfig?optionalIResolvableScalingConfig?optionalIResolvableScalingConfig?optionalinterface{}#

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

subnetsstring | ISubnetRef[]subnetstyping.List[typing.Union[str, ISubnetRef]]subnetsList<String>Subnetsstring[]Subnets*[]interface{}required#

The subnets to use for the Auto Scaling group that is created for your node group.

notes

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?optional{ [key: string]: string }tags?optionaltyping.Mapping[str, str]tags?optionalMap<String, String>Tags?optionalIDictionary<string, string>Tags?optional*map[string]*string#

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?optionalIResolvable | IResolvable | CfnNodegroup.TaintProperty[]taints?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaintProperty]]]taints?optionalIResolvableTaints?optionalIResolvableTaints?optionalinterface{}#

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

notes

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 .

updateConfig?optionalIResolvable | CfnNodegroup.UpdateConfigPropertyupdate_config?optionaltyping.Union[IResolvable, UpdateConfigProperty]updateConfig?optionalIResolvableUpdateConfig?optionalIResolvableUpdateConfig?optionalinterface{}#

The node group update configuration.

version?optionalstringversion?optionalstrversion?optionalStringVersion?optionalstringVersion?optional*string#

The Kubernetes version to use for your managed nodes.

notes

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 .

You can't update other properties at the same time as updating Version .

warmPoolConfig?optionalIResolvable | CfnNodegroup.WarmPoolConfigPropertywarm_pool_config?optionaltyping.Union[IResolvable, WarmPoolConfigProperty]warmPoolConfig?optionalIResolvableWarmPoolConfig?optionalIResolvableWarmPoolConfig?optionalinterface{}#

The warm pool configuration for the node group.

Properties

amiType?may be undefinedstringami_type?may be undefinedstramiType?may be undefinedStringAmiType?may be undefinedstringAmiType?may be undefined*string#

The AMI type for your node group.

attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*stringrequired#

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

attrClusterNamestringattr_cluster_namestrattrClusterNameStringAttrClusterNamestringAttrClusterName*stringrequired#

The name of your cluster.

attrIdstringattr_idstrattrIdStringAttrIdstringAttrId*stringrequired#

attrNodegroupNamestringattr_nodegroup_namestrattrNodegroupNameStringAttrNodegroupNamestringAttrNodegroupName*stringrequired#

The name associated with an Amazon EKS managed node group.

capacityType?may be undefinedstringcapacity_type?may be undefinedstrcapacityType?may be undefinedStringCapacityType?may be undefinedstringCapacityType?may be undefined*string#

The capacity type of your managed node group.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#

AWS resource type.

clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*stringrequired#

The name of your cluster.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#

diskSize?may be undefinednumberdisk_size?may be undefinedint | floatdiskSize?may be undefinedNumberDiskSize?may be undefineddoubleDiskSize?may be undefined*float64#

The root device disk size (in GiB) for your node group instances.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

forceUpdateEnabled?may be undefinedboolean | IResolvableforce_update_enabled?may be undefinedtyping.Union[bool, IResolvable]forceUpdateEnabled?may be undefinedBooleanForceUpdateEnabled?may be undefinedboolForceUpdateEnabled?may be undefinedinterface{}#

Force the update if any `Pod` on the existing node group can't be drained due to a `Pod` disruption budget issue.

instanceTypes?may be undefinedstring[]instance_types?may be undefinedtyping.List[str]instanceTypes?may be undefinedList<String>InstanceTypes?may be undefinedstring[]InstanceTypes?may be undefined*[]*string#

Specify the instance types for a node group.

labels?may be undefinedIResolvable | { [key: string]: string }labels?may be undefinedtyping.Union[IResolvable, typing.Mapping[str, str]]labels?may be undefinedIResolvableLabels?may be undefinedIResolvableLabels?may be undefinedinterface{}#

The Kubernetes `labels` applied to the nodes in the node group.

launchTemplate?may be undefinedIResolvable | CfnNodegroup.LaunchTemplateSpecificationPropertylaunch_template?may be undefinedtyping.Union[IResolvable, LaunchTemplateSpecificationProperty]launchTemplate?may be undefinedIResolvableLaunchTemplate?may be undefinedIResolvableLaunchTemplate?may be undefinedinterface{}#

An object representing a node group's launch template specification.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

nodegroupName?may be undefinedstringnodegroup_name?may be undefinedstrnodegroupName?may be undefinedStringNodegroupName?may be undefinedstringNodegroupName?may be undefined*string#

The unique name to give your node group.

nodegroupRefNodegroupReferencenodegroup_refNodegroupReferencenodegroupRefNodegroupReferenceNodegroupRefNodegroupReferenceNodegroupRefNodegroupReferencerequired#

A reference to a Nodegroup resource.

nodeRepairConfig?may be undefinedIResolvable | CfnNodegroup.NodeRepairConfigPropertynode_repair_config?may be undefinedtyping.Union[IResolvable, NodeRepairConfigProperty]nodeRepairConfig?may be undefinedIResolvableNodeRepairConfig?may be undefinedIResolvableNodeRepairConfig?may be undefinedinterface{}#

The node auto repair configuration for the node group.

nodeRolestringnode_rolestrnodeRoleStringNodeRolestringNodeRole*stringrequired#

The Amazon Resource Name (ARN) of the IAM role to associate with your node group.

refstringrefstrrefStringRefstringRef*stringrequired#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

releaseVersion?may be undefinedstringrelease_version?may be undefinedstrreleaseVersion?may be undefinedStringReleaseVersion?may be undefinedstringReleaseVersion?may be undefined*string#

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://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide* .

remoteAccess?may be undefinedIResolvable | CfnNodegroup.RemoteAccessPropertyremote_access?may be undefinedtyping.Union[IResolvable, RemoteAccessProperty]remoteAccess?may be undefinedIResolvableRemoteAccess?may be undefinedIResolvableRemoteAccess?may be undefinedinterface{}#

The remote access configuration to use with your node group.

scalingConfig?may be undefinedIResolvable | CfnNodegroup.ScalingConfigPropertyscaling_config?may be undefinedtyping.Union[IResolvable, ScalingConfigProperty]scalingConfig?may be undefinedIResolvableScalingConfig?may be undefinedIResolvableScalingConfig?may be undefinedinterface{}#

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

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

subnetsstring[]subnetstyping.List[str]subnetsList<String>Subnetsstring[]Subnets*[]*stringrequired#

The subnets to use for the Auto Scaling group that is created for your node group.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefined{ [key: string]: string }tags_raw?may be undefinedtyping.Mapping[str, str]tagsRaw?may be undefinedMap<String, String>TagsRaw?may be undefinedIDictionary<string, string>TagsRaw?may be undefined*map[string]*string#

Metadata that assists with categorization and organization.

taints?may be undefinedIResolvable | IResolvable | CfnNodegroup.TaintProperty[]taints?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaintProperty]]]taints?may be undefinedIResolvableTaints?may be undefinedIResolvableTaints?may be undefinedinterface{}#

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

updateConfig?may be undefinedIResolvable | CfnNodegroup.UpdateConfigPropertyupdate_config?may be undefinedtyping.Union[IResolvable, UpdateConfigProperty]updateConfig?may be undefinedIResolvableUpdateConfig?may be undefinedIResolvableUpdateConfig?may be undefinedinterface{}#

The node group update configuration.

version?may be undefinedstringversion?may be undefinedstrversion?may be undefinedStringVersion?may be undefinedstringVersion?may be undefined*string#

The Kubernetes version to use for your managed nodes.

warmPoolConfig?may be undefinedIResolvable | CfnNodegroup.WarmPoolConfigPropertywarm_pool_config?may be undefinedtyping.Union[IResolvable, WarmPoolConfigProperty]warmPoolConfig?may be undefinedIResolvableWarmPoolConfig?may be undefinedIResolvableWarmPoolConfig?may be undefinedinterface{}#

The warm pool configuration for the node group.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForNodegroup(resource: INodegroupRef): string@staticmethod def arn_for_nodegroup(resource: INodegroupRef) -> strpublic static String arnForNodegroup(INodegroupRef resource)public static string ArnForNodegroup(INodegroupRef resource)func ArnForNodegroup(Resource INodegroupRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnNodegroup(x: any): boolean@staticmethod def is_cfn_nodegroup(x: Any) -> boolpublic static Boolean isCfnNodegroup(Object x)public static bool IsCfnNodegroup(object x)func IsCfnNodegroup(X interface{}) *boolstatic#

Checks whether the given object is a CfnNodegroup.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.