@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:38.916Z") @Stability(value=Stable) public class CfnNodegroup extends CfnResource implements IInspectable
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 more information about using launch templates, see Launch template support .
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. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide .
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;
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(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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnNodegroup.Builder
A fluent builder for
CfnNodegroup. |
static interface |
CfnNodegroup.LaunchTemplateSpecificationProperty
An object representing a node group launch template specification.
|
static interface |
CfnNodegroup.RemoteAccessProperty
An object representing the remote access configuration for the managed node group.
|
static interface |
CfnNodegroup.ScalingConfigProperty
An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group.
|
static interface |
CfnNodegroup.TaintProperty
A property that allows a node to repel a set of pods.
|
static interface |
CfnNodegroup.UpdateConfigProperty
The update configuration for the node group.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnNodegroup(software.constructs.Construct scope,
String id,
CfnNodegroupProps props)
Create a new `AWS::EKS::Nodegroup`.
|
protected |
CfnNodegroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnNodegroup(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAmiType()
The AMI type for your node group.
|
String |
getAttrArn()
The Amazon Resource Name (ARN) associated with the managed node group.
|
String |
getAttrClusterName()
The name of the cluster that the managed node group resides in.
|
String |
getAttrId() |
String |
getAttrNodegroupName()
The name associated with an Amazon EKS managed node group.
|
String |
getCapacityType()
The capacity type of your managed node group.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getClusterName()
The name of the cluster to create the node group in.
|
Number |
getDiskSize()
The root device disk size (in GiB) for your node group instances.
|
Object |
getForceUpdateEnabled()
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
|
List<String> |
getInstanceTypes()
Specify the instance types for a node group.
|
Object |
getLabels()
The Kubernetes labels to be applied to the nodes in the node group when they are created.
|
Object |
getLaunchTemplate()
An object representing a node group's launch template specification.
|
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.
|
String |
getReleaseVersion()
The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, `1.14.7- *YYYYMMDD*` ).
|
Object |
getRemoteAccess()
The remote access (SSH) configuration to use with your node group.
|
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.
|
TagManager |
getTags()
The metadata to apply to the node group to assist with categorization and organization.
|
Object |
getTaints()
The Kubernetes taints to be applied to the nodes in the node group when they are created.
|
Object |
getUpdateConfig()
The node group update configuration.
|
String |
getVersion()
The Kubernetes version to use for your managed nodes.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAmiType(String value)
The AMI type for your node group.
|
void |
setCapacityType(String value)
The capacity type of your managed node group.
|
void |
setClusterName(String value)
The name of the cluster to create the node group in.
|
void |
setDiskSize(Number value)
The root device disk size (in GiB) for your node group instances.
|
void |
setForceUpdateEnabled(Boolean value)
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
|
void |
setForceUpdateEnabled(IResolvable value)
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
|
void |
setInstanceTypes(List<String> value)
Specify the instance types for a node group.
|
void |
setLabels(Object value)
The Kubernetes labels to be applied to the nodes in the node group when they are created.
|
void |
setLaunchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty value)
An object representing a node group's launch template specification.
|
void |
setLaunchTemplate(IResolvable value)
An object representing a node group's launch template specification.
|
void |
setNodegroupName(String value)
The unique name to give your node group.
|
void |
setNodeRole(String value)
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
|
void |
setReleaseVersion(String value)
The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, `1.14.7- *YYYYMMDD*` ).
|
void |
setRemoteAccess(CfnNodegroup.RemoteAccessProperty value)
The remote access (SSH) configuration to use with your node group.
|
void |
setRemoteAccess(IResolvable value)
The remote access (SSH) configuration to use with your node group.
|
void |
setScalingConfig(CfnNodegroup.ScalingConfigProperty value)
The scaling configuration details for the Auto Scaling group that is created for your node group.
|
void |
setScalingConfig(IResolvable value)
The scaling configuration details for the Auto Scaling group that is created for your node group.
|
void |
setSubnets(List<String> value)
The subnets to use for the Auto Scaling group that is created for your node group.
|
void |
setTaints(IResolvable value)
The Kubernetes taints to be applied to the nodes in the node group when they are created.
|
void |
setTaints(List<Object> value)
The Kubernetes taints to be applied to the nodes in the node group when they are created.
|
void |
setUpdateConfig(CfnNodegroup.UpdateConfigProperty value)
The node group update configuration.
|
void |
setUpdateConfig(IResolvable value)
The node group update configuration.
|
void |
setVersion(String value)
The Kubernetes version to use for your managed nodes.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnNodegroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNodegroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnNodegroup(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnNodegroupProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrClusterName()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull public String getAttrNodegroupName()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
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.
@Stability(value=Stable) @NotNull public String getClusterName()
@Stability(value=Stable)
public void setClusterName(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getLabels()
@Stability(value=Stable)
public void setLabels(@NotNull
Object value)
@Stability(value=Stable) @NotNull public String getNodeRole()
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 .
@Stability(value=Stable)
public void setNodeRole(@NotNull
String value)
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 .
@Stability(value=Stable) @NotNull public List<String> getSubnets()
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 .
@Stability(value=Stable)
public void setSubnets(@NotNull
List<String> value)
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 .
@Stability(value=Stable) @Nullable public String getAmiType()
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 .
@Stability(value=Stable)
public void setAmiType(@Nullable
String value)
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 .
@Stability(value=Stable) @Nullable public String getCapacityType()
@Stability(value=Stable)
public void setCapacityType(@Nullable
String value)
@Stability(value=Stable) @Nullable public Number getDiskSize()
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 .
@Stability(value=Stable)
public void setDiskSize(@Nullable
Number value)
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 .
@Stability(value=Stable) @Nullable public Object getForceUpdateEnabled()
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.
@Stability(value=Stable)
public void setForceUpdateEnabled(@Nullable
Boolean value)
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.
@Stability(value=Stable)
public void setForceUpdateEnabled(@Nullable
IResolvable value)
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.
@Stability(value=Stable) @Nullable public List<String> getInstanceTypes()
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 .
@Stability(value=Stable)
public void setInstanceTypes(@Nullable
List<String> value)
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 .
@Stability(value=Stable) @Nullable public Object getLaunchTemplate()
If specified, then do not specify instanceTypes , diskSize , or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification .
@Stability(value=Stable)
public void setLaunchTemplate(@Nullable
CfnNodegroup.LaunchTemplateSpecificationProperty value)
If specified, then do not specify instanceTypes , diskSize , or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification .
@Stability(value=Stable)
public void setLaunchTemplate(@Nullable
IResolvable value)
If specified, then do not specify instanceTypes , diskSize , or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification .
@Stability(value=Stable) @Nullable public String getNodegroupName()
@Stability(value=Stable)
public void setNodegroupName(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getReleaseVersion()
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.
@Stability(value=Stable)
public void setReleaseVersion(@Nullable
String value)
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.
@Stability(value=Stable) @Nullable public Object getRemoteAccess()
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 .
@Stability(value=Stable)
public void setRemoteAccess(@Nullable
CfnNodegroup.RemoteAccessProperty value)
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 .
@Stability(value=Stable)
public void setRemoteAccess(@Nullable
IResolvable value)
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 .
@Stability(value=Stable) @Nullable public Object getScalingConfig()
@Stability(value=Stable)
public void setScalingConfig(@Nullable
CfnNodegroup.ScalingConfigProperty value)
@Stability(value=Stable)
public void setScalingConfig(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getTaints()
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 .
@Stability(value=Stable)
public void setTaints(@Nullable
IResolvable value)
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 .
@Stability(value=Stable)
public void setTaints(@Nullable
List<Object> value)
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 .
@Stability(value=Stable) @Nullable public Object getUpdateConfig()
@Stability(value=Stable)
public void setUpdateConfig(@Nullable
CfnNodegroup.UpdateConfigProperty value)
@Stability(value=Stable)
public void setUpdateConfig(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getVersion()
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 .
@Stability(value=Stable)
public void setVersion(@Nullable
String value)
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 .
Copyright © 2022. All rights reserved.