Package software.amazon.awscdk.services.eks

Class CfnNodegroup.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnNodegroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNodegroup>

Enclosing class:

CfnNodegroup

@Stability(Stable)
public static final class CfnNodegroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNodegroup>

A fluent builder for CfnNodegroup.

Method Summary

Modifier and Type	Method	Description
CfnNodegroup.Builder	amiType(String amiType)	The AMI type for your node group.
CfnNodegroup	build()
CfnNodegroup.Builder	capacityType(String capacityType)	The capacity type of your managed node group.
CfnNodegroup.Builder	clusterName(String clusterName)	The name of the cluster to create the node group in.
static CfnNodegroup.Builder	create(software.constructs.Construct scope, String id)
CfnNodegroup.Builder	diskSize(Number diskSize)	The root device disk size (in GiB) for your node group instances.
CfnNodegroup.Builder	forceUpdateEnabled(Boolean forceUpdateEnabled)	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
CfnNodegroup.Builder	forceUpdateEnabled(IResolvable forceUpdateEnabled)	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
CfnNodegroup.Builder	instanceTypes(List<String> instanceTypes)	Specify the instance types for a node group.
CfnNodegroup.Builder	labels(Map<String,String> labels)	The Kubernetes labels applied to the nodes in the node group.
CfnNodegroup.Builder	labels(IResolvable labels)	The Kubernetes labels applied to the nodes in the node group.
CfnNodegroup.Builder	launchTemplate(IResolvable launchTemplate)	An object representing a node group's launch template specification.
CfnNodegroup.Builder	launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate)	An object representing a node group's launch template specification.
CfnNodegroup.Builder	nodegroupName(String nodegroupName)	The unique name to give your node group.
CfnNodegroup.Builder	nodeRole(String nodeRole)	The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
CfnNodegroup.Builder	releaseVersion(String releaseVersion)	The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, 1.14.7- *YYYYMMDD* ).
CfnNodegroup.Builder	remoteAccess(IResolvable remoteAccess)	The remote access configuration to use with your node group.
CfnNodegroup.Builder	remoteAccess(CfnNodegroup.RemoteAccessProperty remoteAccess)	The remote access configuration to use with your node group.
CfnNodegroup.Builder	scalingConfig(IResolvable scalingConfig)	The scaling configuration details for the Auto Scaling group that is created for your node group.
CfnNodegroup.Builder	scalingConfig(CfnNodegroup.ScalingConfigProperty scalingConfig)	The scaling configuration details for the Auto Scaling group that is created for your node group.
CfnNodegroup.Builder	subnets(List<String> subnets)	The subnets to use for the Auto Scaling group that is created for your node group.
CfnNodegroup.Builder	tags(Map<String,String> tags)	The metadata applied to the node group to assist with categorization and organization.
CfnNodegroup.Builder	taints(List<? extends Object> taints)	The Kubernetes taints to be applied to the nodes in the node group when they are created.
CfnNodegroup.Builder	taints(IResolvable taints)	The Kubernetes taints to be applied to the nodes in the node group when they are created.
CfnNodegroup.Builder	updateConfig(IResolvable updateConfig)	The node group update configuration.
CfnNodegroup.Builder	updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig)	The node group update configuration.
CfnNodegroup.Builder	version(String version)	The Kubernetes version to use for your managed nodes.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnNodegroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnNodegroup.Builder.

clusterName

@Stability(Stable)
public CfnNodegroup.Builder clusterName(String clusterName)

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

Parameters:

clusterName - The name of the cluster to create the node group in. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-clustername

nodeRole

@Stability(Stable)
public CfnNodegroup.Builder nodeRole(String nodeRole)

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 .

Parameters:

nodeRole - The Amazon Resource Name (ARN) of the IAM role to associate with your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-noderole

subnets

@Stability(Stable)
public CfnNodegroup.Builder subnets(List<String> subnets)

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 .

Parameters:

subnets - The subnets to use for the Auto Scaling group that is created for your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-subnets

amiType

@Stability(Stable)
public CfnNodegroup.Builder amiType(String amiType)

The AMI type for your node group.

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 .

Parameters:

amiType - The AMI type for your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-amitype

capacityType

@Stability(Stable)
public CfnNodegroup.Builder capacityType(String capacityType)

The capacity type of your managed node group.

Parameters:

capacityType - The capacity type of your managed node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-capacitytype

diskSize

@Stability(Stable)
public CfnNodegroup.Builder diskSize(Number diskSize)

The root device disk size (in GiB) for your node group instances.

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 .

Parameters:

diskSize - The root device disk size (in GiB) for your node group instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-disksize

forceUpdateEnabled

@Stability(Stable)
public CfnNodegroup.Builder forceUpdateEnabled(Boolean forceUpdateEnabled)

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.

Default: - false

Parameters:

forceUpdateEnabled - Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled

forceUpdateEnabled

@Stability(Stable)
public CfnNodegroup.Builder forceUpdateEnabled(IResolvable forceUpdateEnabled)

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.

Default: - false

Parameters:

forceUpdateEnabled - Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-forceupdateenabled

instanceTypes

@Stability(Stable)
public CfnNodegroup.Builder instanceTypes(List<String> instanceTypes)

Specify the instance types for a node group.

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 .

Parameters:

instanceTypes - Specify the instance types for a node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

labels

@Stability(Stable)
public CfnNodegroup.Builder labels(IResolvable labels)

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.

Parameters:

labels - The Kubernetes labels applied to the nodes in the node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels

labels

@Stability(Stable)
public CfnNodegroup.Builder labels(Map<String,String> labels)

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.

Parameters:

labels - The Kubernetes labels applied to the nodes in the node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-labels

launchTemplate

@Stability(Stable)
public CfnNodegroup.Builder launchTemplate(IResolvable launchTemplate)

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 .

Parameters:

launchTemplate - An object representing a node group's launch template specification. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-launchtemplate

launchTemplate

@Stability(Stable)
public CfnNodegroup.Builder launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate)

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 .

Parameters:

launchTemplate - An object representing a node group's launch template specification. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-launchtemplate

nodegroupName

@Stability(Stable)
public CfnNodegroup.Builder nodegroupName(String nodegroupName)

The unique name to give your node group.

Parameters:

nodegroupName - The unique name to give your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-nodegroupname

releaseVersion

@Stability(Stable)
public CfnNodegroup.Builder releaseVersion(String releaseVersion)

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

Parameters:

releaseVersion - 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 in the Amazon EKS User Guide . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-releaseversion

remoteAccess

@Stability(Stable)
public CfnNodegroup.Builder remoteAccess(IResolvable remoteAccess)

The remote access configuration to use with your node group.

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 .

Parameters:

remoteAccess - The remote access configuration to use with your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess

remoteAccess

@Stability(Stable)
public CfnNodegroup.Builder remoteAccess(CfnNodegroup.RemoteAccessProperty remoteAccess)

The remote access configuration to use with your node group.

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 .

Parameters:

remoteAccess - The remote access configuration to use with your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-remoteaccess

scalingConfig

@Stability(Stable)
public CfnNodegroup.Builder scalingConfig(IResolvable scalingConfig)

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

Parameters:

scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig

scalingConfig

@Stability(Stable)
public CfnNodegroup.Builder scalingConfig(CfnNodegroup.ScalingConfigProperty scalingConfig)

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

Parameters:

scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-scalingconfig

tags

@Stability(Stable)
public CfnNodegroup.Builder tags(Map<String,String> tags)

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.

Parameters:

tags - The metadata applied to the node group to assist with categorization and organization. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-tags

taints

@Stability(Stable)
public CfnNodegroup.Builder taints(IResolvable taints)

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 .

Parameters:

taints - The Kubernetes taints to be applied to the nodes in the node group when they are created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-taints

taints

@Stability(Stable)
public CfnNodegroup.Builder taints(List<? extends Object> taints)

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 .

Parameters:

taints - The Kubernetes taints to be applied to the nodes in the node group when they are created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-taints

updateConfig

@Stability(Stable)
public CfnNodegroup.Builder updateConfig(IResolvable updateConfig)

The node group update configuration.

Parameters:

updateConfig - The node group update configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-updateconfig

updateConfig

@Stability(Stable)
public CfnNodegroup.Builder updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig)

The node group update configuration.

Parameters:

updateConfig - The node group update configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-updateconfig

version

@Stability(Stable)
public CfnNodegroup.Builder version(String version)

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 .

Parameters:

version - The Kubernetes version to use for your managed nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-version

build

@Stability(Stable)
public CfnNodegroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnNodegroup>

Returns:

a newly built instance of CfnNodegroup.