software.amazon.awscdk.services.eks

Class Nodegroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.eks.Nodegroup

All Implemented Interfaces:

IConstruct, IDependable, IResource, INodegroup

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:38.343Z")
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)
         .instanceType(instanceType)
         .instanceTypes(List.of(instanceType))
         .labels(Map.of(
                 "labelsKey", "labels"))
         .launchTemplateSpec(LaunchTemplateSpec.builder()
                 .id("id")
                 // the properties below are optional
                 .version("version")
                 .build())
         .maxSize(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")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.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 and Description
static class	Nodegroup.Builder A fluent builder for Nodegroup.

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

INodegroup.Jsii$Default, INodegroup.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Nodegroup

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

Nodegroup

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

Nodegroup

public Nodegroup(software.constructs.Construct scope,
                 java.lang.String id,
                 NodegroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromNodegroupName

public static INodegroup fromNodegroupName(software.constructs.Construct scope,
                                           java.lang.String id,
                                           java.lang.String nodegroupName)

Import the Nodegroup from attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

nodegroupName - This parameter is required.

getCluster

public ICluster getCluster()

the Amazon EKS cluster resource.

getNodegroupArn

public java.lang.String getNodegroupArn()

ARN of the nodegroup.

getNodegroupName

public java.lang.String getNodegroupName()

Nodegroup name.

Specified by:

getNodegroupName in interface INodegroup

getRole

public IRole getRole()

IAM role of the instance profile for the nodegroup.