Package software.amazon.awscdk.services.eks

Class Nodegroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.eks.Nodegroup

All Implemented Interfaces:

IResource, INodegroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.939Z")
@Stability(Stable)
public class Nodegroup
extends Resource
implements INodegroup

The Nodegroup resource class.

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.ec2.*;
 import software.amazon.awscdk.services.eks.*;
 import software.amazon.awscdk.services.iam.*;
 Cluster cluster;
 InstanceType instanceType;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Nodegroup nodegroup = Nodegroup.Builder.create(this, "MyNodegroup")
         .cluster(cluster)
         // the properties below are optional
         .amiType(NodegroupAmiType.AL2_X86_64)
         .capacityType(CapacityType.SPOT)
         .desiredSize(123)
         .diskSize(123)
         .forceUpdate(false)
         .instanceTypes(List.of(instanceType))
         .labels(Map.of(
                 "labelsKey", "labels"))
         .launchTemplateSpec(LaunchTemplateSpec.builder()
                 .id("id")
                 // the properties below are optional
                 .version("version")
                 .build())
         .maxSize(123)
         .maxUnavailable(123)
         .maxUnavailablePercentage(123)
         .minSize(123)
         .nodegroupName("nodegroupName")
         .nodeRole(role)
         .releaseVersion("releaseVersion")
         .remoteAccess(NodegroupRemoteAccess.builder()
                 .sshKeyName("sshKeyName")
                 // the properties below are optional
                 .sourceSecurityGroups(List.of(securityGroup))
                 .build())
         .subnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .taints(List.of(TaintSpec.builder()
                 .effect(TaintEffect.NO_SCHEDULE)
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Nodegroup.Builder	A fluent builder for Nodegroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.INodegroup

INodegroup.Jsii$Default, INodegroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Nodegroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Nodegroup(software.amazon.jsii.JsiiObjectRef objRef)
	Nodegroup(software.constructs.Construct scope, String id, NodegroupProps props)

Method Summary

Modifier and Type	Method	Description
static INodegroup	fromNodegroupName(software.constructs.Construct scope, String id, String nodegroupName)	Import the Nodegroup from attributes.
ICluster	getCluster()	the Amazon EKS cluster resource.
String	getNodegroupArn()	ARN of the nodegroup.
String	getNodegroupName()	Nodegroup name.
IRole	getRole()	IAM role of the instance profile for the nodegroup.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Nodegroup

protected Nodegroup(software.amazon.jsii.JsiiObjectRef objRef)

Nodegroup

protected Nodegroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Nodegroup

@Stability(Stable)
public Nodegroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 NodegroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromNodegroupName

@Stability(Stable)
@NotNull
public static INodegroup fromNodegroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String nodegroupName)

Import the Nodegroup from attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

nodegroupName - This parameter is required.

getCluster

@Stability(Stable)
@NotNull
public ICluster getCluster()

the Amazon EKS cluster resource.

getNodegroupArn

@Stability(Stable)
@NotNull
public String getNodegroupArn()

ARN of the nodegroup.

getNodegroupName

@Stability(Stable)
@NotNull
public String getNodegroupName()

Nodegroup name.

Specified by:

getNodegroupName in interface INodegroup

getRole

@Stability(Stable)
@NotNull
public IRole getRole()

IAM role of the instance profile for the nodegroup.