@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:48.998Z") 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. For more information, see Managed node groups in the Amazon EKS User Guide .
Windows AMI types are only supported for commercial Regions that support Windows Amazon EKS.
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.*; 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") .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) .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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnNodegroup(Construct scope,
java.lang.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 |
---|---|
java.lang.String |
getAmiType()
The AMI type for your node group.
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) associated with the managed node group.
|
java.lang.String |
getAttrClusterName()
The name of the cluster that the managed node group resides in.
|
java.lang.String |
getAttrId() |
java.lang.String |
getAttrNodegroupName()
The name associated with an Amazon EKS managed node group.
|
java.lang.String |
getCapacityType()
The capacity type of your managed node group.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getClusterName()
The name of the cluster to create the node group in.
|
java.lang.Number |
getDiskSize()
The root device disk size (in GiB) for your node group instances.
|
java.lang.Object |
getForceUpdateEnabled()
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
|
java.util.List<java.lang.String> |
getInstanceTypes()
Specify the instance types for a node group.
|
java.lang.Object |
getLabels()
The Kubernetes labels applied to the nodes in the node group.
|
java.lang.Object |
getLaunchTemplate()
An object representing a node group's launch template specification.
|
java.lang.String |
getNodegroupName()
The unique name to give your node group.
|
java.lang.String |
getNodeRole()
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
|
java.lang.String |
getReleaseVersion()
The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, `1.14.7- *YYYYMMDD*` ).
|
java.lang.Object |
getRemoteAccess()
The remote access configuration to use with your node group.
|
java.lang.Object |
getScalingConfig()
The scaling configuration details for the Auto Scaling group that is created for your node group.
|
java.util.List<java.lang.String> |
getSubnets()
The subnets to use for the Auto Scaling group that is created for your node group.
|
TagManager |
getTags()
The metadata applied to the node group to assist with categorization and organization.
|
java.lang.Object |
getTaints()
The Kubernetes taints to be applied to the nodes in the node group when they are created.
|
java.lang.Object |
getUpdateConfig()
The node group update configuration.
|
java.lang.String |
getVersion()
The Kubernetes version to use for your managed nodes.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAmiType(java.lang.String value)
The AMI type for your node group.
|
void |
setCapacityType(java.lang.String value)
The capacity type of your managed node group.
|
void |
setClusterName(java.lang.String value)
The name of the cluster to create the node group in.
|
void |
setDiskSize(java.lang.Number value)
The root device disk size (in GiB) for your node group instances.
|
void |
setForceUpdateEnabled(java.lang.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(java.util.List<java.lang.String> value)
Specify the instance types for a node group.
|
void |
setLabels(IResolvable value)
The Kubernetes labels applied to the nodes in the node group.
|
void |
setLabels(java.util.Map<java.lang.String,java.lang.String> value)
The Kubernetes labels applied to the nodes in the node group.
|
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(java.lang.String value)
The unique name to give your node group.
|
void |
setNodeRole(java.lang.String value)
The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
|
void |
setReleaseVersion(java.lang.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 configuration to use with your node group.
|
void |
setRemoteAccess(IResolvable value)
The remote access 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(java.util.List<java.lang.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(java.util.List<java.lang.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(java.lang.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, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnNodegroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNodegroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnNodegroup(Construct scope, java.lang.String id, 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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrClusterName()
public java.lang.String getAttrId()
public java.lang.String getAttrNodegroupName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
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.
public java.lang.String getClusterName()
public void setClusterName(java.lang.String value)
public java.lang.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 .
public void setNodeRole(java.lang.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 .
public java.util.List<java.lang.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 .
public void setSubnets(java.util.List<java.lang.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 .
public java.lang.String getAmiType()
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 Launch template support in the Amazon EKS User Guide .
public void setAmiType(java.lang.String value)
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 Launch template support in the Amazon EKS User Guide .
public java.lang.String getCapacityType()
public void setCapacityType(java.lang.String value)
public java.lang.Number getDiskSize()
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 Launch template support in the Amazon EKS User Guide .
public void setDiskSize(java.lang.Number value)
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 Launch template support in the Amazon EKS User Guide .
public java.lang.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.
public void setForceUpdateEnabled(java.lang.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.
public void setForceUpdateEnabled(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.
public java.util.List<java.lang.String> getInstanceTypes()
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 Launch template support in the Amazon EKS User Guide .
public void setInstanceTypes(java.util.List<java.lang.String> value)
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 Launch template support in the Amazon EKS User Guide .
public java.lang.Object getLabels()
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.
public void setLabels(IResolvable value)
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.
public void setLabels(java.util.Map<java.lang.String,java.lang.String> value)
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.
public java.lang.Object getLaunchTemplate()
If specified, then do not specify instanceTypes
, diskSize
, or remoteAccess
and make sure that the launch template meets the requirements in launchTemplateSpecification
.
public void setLaunchTemplate(IResolvable value)
If specified, then do not specify instanceTypes
, diskSize
, or remoteAccess
and make sure that the launch template meets the requirements in launchTemplateSpecification
.
public void setLaunchTemplate(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
.
public java.lang.String getNodegroupName()
public void setNodegroupName(java.lang.String value)
public java.lang.String getReleaseVersion()
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
.
public void setReleaseVersion(java.lang.String value)
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
.
public java.lang.Object getRemoteAccess()
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 Launch template support in the Amazon EKS User Guide .
public void setRemoteAccess(IResolvable value)
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 Launch template support in the Amazon EKS User Guide .
public void setRemoteAccess(CfnNodegroup.RemoteAccessProperty value)
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 Launch template support in the Amazon EKS User Guide .
public java.lang.Object getScalingConfig()
public void setScalingConfig(IResolvable value)
public void setScalingConfig(CfnNodegroup.ScalingConfigProperty value)
public java.lang.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 .
public void setTaints(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 .
public void setTaints(java.util.List<java.lang.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 .
public java.lang.Object getUpdateConfig()
public void setUpdateConfig(IResolvable value)
public void setUpdateConfig(CfnNodegroup.UpdateConfigProperty value)
public java.lang.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 .
You can't update other properties at the same time as updating
Version
.
public void setVersion(java.lang.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 .
You can't update other properties at the same time as updating
Version
.