software.amazon.awscdk.services.eks

Class CfnNodegroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnNodegroupProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNodegroupProps>

Enclosing interface:

CfnNodegroupProps

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

A builder for CfnNodegroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnNodegroupProps.Builder	amiType(String amiType) Sets the value of CfnNodegroupProps.getAmiType()
CfnNodegroupProps	build() Builds the configured instance.
CfnNodegroupProps.Builder	capacityType(String capacityType) Sets the value of CfnNodegroupProps.getCapacityType()
CfnNodegroupProps.Builder	clusterName(String clusterName) Sets the value of CfnNodegroupProps.getClusterName()
CfnNodegroupProps.Builder	diskSize(Number diskSize) Sets the value of CfnNodegroupProps.getDiskSize()
CfnNodegroupProps.Builder	forceUpdateEnabled(Boolean forceUpdateEnabled) Sets the value of CfnNodegroupProps.getForceUpdateEnabled()
CfnNodegroupProps.Builder	forceUpdateEnabled(IResolvable forceUpdateEnabled) Sets the value of CfnNodegroupProps.getForceUpdateEnabled()
CfnNodegroupProps.Builder	instanceTypes(List<String> instanceTypes) Sets the value of CfnNodegroupProps.getInstanceTypes()
CfnNodegroupProps.Builder	labels(Object labels) Sets the value of CfnNodegroupProps.getLabels()
CfnNodegroupProps.Builder	launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate) Sets the value of CfnNodegroupProps.getLaunchTemplate()
CfnNodegroupProps.Builder	launchTemplate(IResolvable launchTemplate) Sets the value of CfnNodegroupProps.getLaunchTemplate()
CfnNodegroupProps.Builder	nodegroupName(String nodegroupName) Sets the value of CfnNodegroupProps.getNodegroupName()
CfnNodegroupProps.Builder	nodeRole(String nodeRole) Sets the value of CfnNodegroupProps.getNodeRole()
CfnNodegroupProps.Builder	releaseVersion(String releaseVersion) Sets the value of CfnNodegroupProps.getReleaseVersion()
CfnNodegroupProps.Builder	remoteAccess(CfnNodegroup.RemoteAccessProperty remoteAccess) Sets the value of CfnNodegroupProps.getRemoteAccess()
CfnNodegroupProps.Builder	remoteAccess(IResolvable remoteAccess) Sets the value of CfnNodegroupProps.getRemoteAccess()
CfnNodegroupProps.Builder	scalingConfig(CfnNodegroup.ScalingConfigProperty scalingConfig) Sets the value of CfnNodegroupProps.getScalingConfig()
CfnNodegroupProps.Builder	scalingConfig(IResolvable scalingConfig) Sets the value of CfnNodegroupProps.getScalingConfig()
CfnNodegroupProps.Builder	subnets(List<String> subnets) Sets the value of CfnNodegroupProps.getSubnets()
CfnNodegroupProps.Builder	tags(Object tags) Sets the value of CfnNodegroupProps.getTags()
CfnNodegroupProps.Builder	taints(IResolvable taints) Sets the value of CfnNodegroupProps.getTaints()
CfnNodegroupProps.Builder	taints(List<? extends Object> taints) Sets the value of CfnNodegroupProps.getTaints()
CfnNodegroupProps.Builder	updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig) Sets the value of CfnNodegroupProps.getUpdateConfig()
CfnNodegroupProps.Builder	updateConfig(IResolvable updateConfig) Sets the value of CfnNodegroupProps.getUpdateConfig()
CfnNodegroupProps.Builder	version(String version) Sets the value of CfnNodegroupProps.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

clusterName

@Stability(value=Stable)
public CfnNodegroupProps.Builder clusterName(String clusterName)

Sets the value of CfnNodegroupProps.getClusterName()

Parameters:

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

Returns:

this

nodeRole

@Stability(value=Stable)
public CfnNodegroupProps.Builder nodeRole(String nodeRole)

Sets the value of CfnNodegroupProps.getNodeRole()

Parameters:

nodeRole - The Amazon Resource Name (ARN) of the IAM role to associate with your node group. This parameter is required. 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 .

Returns:

this

subnets

@Stability(value=Stable)
public CfnNodegroupProps.Builder subnets(List<String> subnets)

Sets the value of CfnNodegroupProps.getSubnets()

Parameters:

subnets - The subnets to use for the Auto Scaling group that is created for your node group. This parameter is required. 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 .

Returns:

this

amiType

@Stability(value=Stable)
public CfnNodegroupProps.Builder amiType(String amiType)

Sets the value of CfnNodegroupProps.getAmiType()

Parameters:

amiType - The AMI type for your node group. 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 .

Returns:

this

capacityType

@Stability(value=Stable)
public CfnNodegroupProps.Builder capacityType(String capacityType)

Sets the value of CfnNodegroupProps.getCapacityType()

Parameters:

capacityType - The capacity type of your managed node group.

Returns:

this

diskSize

@Stability(value=Stable)
public CfnNodegroupProps.Builder diskSize(Number diskSize)

Sets the value of CfnNodegroupProps.getDiskSize()

Parameters:

diskSize - The root device disk size (in GiB) for your node group instances. 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 .

Returns:

this

forceUpdateEnabled

@Stability(value=Stable)
public CfnNodegroupProps.Builder forceUpdateEnabled(Boolean forceUpdateEnabled)

Sets the value of CfnNodegroupProps.getForceUpdateEnabled()

Parameters:

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.

Returns:

this

forceUpdateEnabled

@Stability(value=Stable)
public CfnNodegroupProps.Builder forceUpdateEnabled(IResolvable forceUpdateEnabled)

Sets the value of CfnNodegroupProps.getForceUpdateEnabled()

Parameters:

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.

Returns:

this

instanceTypes

@Stability(value=Stable)
public CfnNodegroupProps.Builder instanceTypes(List<String> instanceTypes)

Sets the value of CfnNodegroupProps.getInstanceTypes()

Parameters:

instanceTypes - Specify the instance types for a node group. 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 .

Returns:

this

labels

@Stability(value=Stable)
public CfnNodegroupProps.Builder labels(Object labels)

Sets the value of CfnNodegroupProps.getLabels()

Parameters:

labels - The Kubernetes labels to be applied to the nodes in the node group when they are created.

Returns:

this

launchTemplate

@Stability(value=Stable)
public CfnNodegroupProps.Builder launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate)

Sets the value of CfnNodegroupProps.getLaunchTemplate()

Parameters:

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 .

Returns:

this

launchTemplate

@Stability(value=Stable)
public CfnNodegroupProps.Builder launchTemplate(IResolvable launchTemplate)

Sets the value of CfnNodegroupProps.getLaunchTemplate()

Parameters:

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 .

Returns:

this

nodegroupName

@Stability(value=Stable)
public CfnNodegroupProps.Builder nodegroupName(String nodegroupName)

Sets the value of CfnNodegroupProps.getNodegroupName()

Parameters:

nodegroupName - The unique name to give your node group.

Returns:

this

releaseVersion

@Stability(value=Stable)
public CfnNodegroupProps.Builder releaseVersion(String releaseVersion)

Sets the value of CfnNodegroupProps.getReleaseVersion()

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](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide* .

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.

Returns:

this

remoteAccess

@Stability(value=Stable)
public CfnNodegroupProps.Builder remoteAccess(CfnNodegroup.RemoteAccessProperty remoteAccess)

Sets the value of CfnNodegroupProps.getRemoteAccess()

Parameters:

remoteAccess - The remote access (SSH) configuration to use with your node group. 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 .

Returns:

this

remoteAccess

@Stability(value=Stable)
public CfnNodegroupProps.Builder remoteAccess(IResolvable remoteAccess)

Sets the value of CfnNodegroupProps.getRemoteAccess()

Parameters:

remoteAccess - The remote access (SSH) configuration to use with your node group. 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 .

Returns:

this

scalingConfig

@Stability(value=Stable)
public CfnNodegroupProps.Builder scalingConfig(CfnNodegroup.ScalingConfigProperty scalingConfig)

Sets the value of CfnNodegroupProps.getScalingConfig()

Parameters:

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

Returns:

this

scalingConfig

@Stability(value=Stable)
public CfnNodegroupProps.Builder scalingConfig(IResolvable scalingConfig)

Sets the value of CfnNodegroupProps.getScalingConfig()

Parameters:

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

Returns:

this

tags

@Stability(value=Stable)
public CfnNodegroupProps.Builder tags(Object tags)

Sets the value of CfnNodegroupProps.getTags()

Parameters:

tags - The metadata to apply 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.

Returns:

this

taints

@Stability(value=Stable)
public CfnNodegroupProps.Builder taints(IResolvable taints)

Sets the value of CfnNodegroupProps.getTaints()

Parameters:

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 .

Returns:

this

taints

@Stability(value=Stable)
public CfnNodegroupProps.Builder taints(List<? extends Object> taints)

Sets the value of CfnNodegroupProps.getTaints()

Parameters:

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 .

Returns:

this

updateConfig

@Stability(value=Stable)
public CfnNodegroupProps.Builder updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig)

Sets the value of CfnNodegroupProps.getUpdateConfig()

Parameters:

updateConfig - The node group update configuration.

Returns:

this

updateConfig

@Stability(value=Stable)
public CfnNodegroupProps.Builder updateConfig(IResolvable updateConfig)

Sets the value of CfnNodegroupProps.getUpdateConfig()

Parameters:

updateConfig - The node group update configuration.

Returns:

this

version

@Stability(value=Stable)
public CfnNodegroupProps.Builder version(String version)

Sets the value of CfnNodegroupProps.getVersion()

Parameters:

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 .

Returns:

this

build

@Stability(value=Stable)
public CfnNodegroupProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnNodegroupProps

Throws:

NullPointerException - if any required attribute was not provided