software.amazon.awscdk.services.eks

Interface CfnNodegroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnNodegroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:46.664Z")
 @Stability(value=Stable)
public interface CfnNodegroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnNodegroup`.

Example:

 // 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.*;
 Object labels;
 Object tags;
 CfnNodegroupProps cfnNodegroupProps = CfnNodegroupProps.builder()
         .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(labels)
         .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                 .id("id")
                 .name("name")
                 .version("version")
                 .build())
         .nodegroupName("nodegroupName")
         .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(tags)
         .taints(List.of(TaintProperty.builder()
                 .effect("effect")
                 .key("key")
                 .value("value")
                 .build()))
         .updateConfig(UpdateConfigProperty.builder()
                 .maxUnavailable(123)
                 .maxUnavailablePercentage(123)
                 .build())
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnNodegroupProps.Builder A builder for CfnNodegroupProps
static class	CfnNodegroupProps.Jsii$Proxy An implementation for CfnNodegroupProps

Method Summary

Modifier and Type	Method and Description
static CfnNodegroupProps.Builder	builder()
default String	getAmiType() The AMI type for your node group.
default String	getCapacityType() The capacity type of your managed node group.
String	getClusterName() The name of the cluster to create the node group in.
default Number	getDiskSize() The root device disk size (in GiB) for your node group instances.
default Object	getForceUpdateEnabled() Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
default List<String>	getInstanceTypes() Specify the instance types for a node group.
default Object	getLabels() The Kubernetes labels applied to the nodes in the node group.
default Object	getLaunchTemplate() An object representing a node group's launch template specification.
default String	getNodegroupName() The unique name to give your node group.
String	getNodeRole() The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
default String	getReleaseVersion() The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, `1.14.7- *YYYYMMDD*` ).
default Object	getRemoteAccess() The remote access (SSH) configuration to use with your node group.
default Object	getScalingConfig() The scaling configuration details for the Auto Scaling group that is created for your node group.
List<String>	getSubnets() The subnets to use for the Auto Scaling group that is created for your node group.
default Object	getTags() The metadata applied to the node group to assist with categorization and organization.
default Object	getTaints() The Kubernetes taints to be applied to the nodes in the node group when they are created.
default Object	getUpdateConfig() The node group update configuration.
default String	getVersion() The Kubernetes version to use for your managed nodes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterName

@Stability(value=Stable)
 @NotNull
String getClusterName()

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

getNodeRole

@Stability(value=Stable)
 @NotNull
String getNodeRole()

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

getSubnets

@Stability(value=Stable)
 @NotNull
List<String> getSubnets()

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

getAmiType

@Stability(value=Stable)
 @Nullable
default String getAmiType()

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 .

getCapacityType

@Stability(value=Stable)
 @Nullable
default String getCapacityType()

The capacity type of your managed node group.

getDiskSize

@Stability(value=Stable)
 @Nullable
default Number getDiskSize()

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 .

getForceUpdateEnabled

@Stability(value=Stable)
 @Nullable
default Object getForceUpdateEnabled()

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.

getInstanceTypes

@Stability(value=Stable)
 @Nullable
default List<String> getInstanceTypes()

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 .

getLabels

@Stability(value=Stable)
 @Nullable
default Object getLabels()

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.

getLaunchTemplate

@Stability(value=Stable)
 @Nullable
default Object getLaunchTemplate()

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 .

getNodegroupName

@Stability(value=Stable)
 @Nullable
default String getNodegroupName()

The unique name to give your node group.

getReleaseVersion

@Stability(value=Stable)
 @Nullable
default String getReleaseVersion()

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 .

getRemoteAccess

@Stability(value=Stable)
 @Nullable
default Object getRemoteAccess()

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 .

getScalingConfig

@Stability(value=Stable)
 @Nullable
default Object getScalingConfig()

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

getTags

@Stability(value=Stable)
 @Nullable
default Object getTags()

The metadata applied 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.

getTaints

@Stability(value=Stable)
 @Nullable
default Object getTaints()

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 .

getUpdateConfig

@Stability(value=Stable)
 @Nullable
default Object getUpdateConfig()

The node group update configuration.

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

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 .

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

builder

@Stability(value=Stable)
static CfnNodegroupProps.Builder builder()

Returns:

a CfnNodegroupProps.Builder of CfnNodegroupProps