Package software.amazon.awscdk.cfnpropertymixins.services.eks

Class CfnNodegroupMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.eks.CfnNodegroupMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNodegroupMixinProps>

Enclosing interface:

CfnNodegroupMixinProps

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

A builder for CfnNodegroupMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

amiType

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

Sets the value of CfnNodegroupMixinProps.getAmiType()

Parameters:

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

capacityType

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

Sets the value of CfnNodegroupMixinProps.getCapacityType()

Parameters:

capacityType - The capacity type of your managed node group.

Returns:

this

clusterName

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

Sets the value of CfnNodegroupMixinProps.getClusterName()

Parameters:

clusterName - The name of your cluster.

Returns:

this

clusterName

@Stability(Stable)
public CfnNodegroupMixinProps.Builder clusterName(IClusterRef clusterName)

Sets the value of CfnNodegroupMixinProps.getClusterName()

Parameters:

clusterName - The name of your cluster.

Returns:

this

diskSize

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

Sets the value of CfnNodegroupMixinProps.getDiskSize()

Parameters:

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

forceUpdateEnabled

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

Sets the value of CfnNodegroupMixinProps.getForceUpdateEnabled()

Parameters:

forceUpdateEnabled - Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any Pod is running on the node.

Returns:

this

forceUpdateEnabled

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

Sets the value of CfnNodegroupMixinProps.getForceUpdateEnabled()

Parameters:

forceUpdateEnabled - Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not any Pod is running on the node.

Returns:

this

instanceTypes

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

Sets the value of CfnNodegroupMixinProps.getInstanceTypes()

Parameters:

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

labels

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

Sets the value of CfnNodegroupMixinProps.getLabels()

Parameters:

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.

Returns:

this

labels

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

Sets the value of CfnNodegroupMixinProps.getLabels()

Parameters:

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.

Returns:

this

launchTemplate

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

Sets the value of CfnNodegroupMixinProps.getLaunchTemplate()

Parameters:

launchTemplate - An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . You cannot later specify a different launch template ID or name than what was used to create the node group.

Make sure that the launch template meets the requirements in launchTemplateSpecification . Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

launchTemplate

@Stability(Stable)
public CfnNodegroupMixinProps.Builder launchTemplate(CfnNodegroupPropsMixin.LaunchTemplateSpecificationProperty launchTemplate)

Sets the value of CfnNodegroupMixinProps.getLaunchTemplate()

Parameters:

launchTemplate - An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . You cannot later specify a different launch template ID or name than what was used to create the node group.

Make sure that the launch template meets the requirements in launchTemplateSpecification . Also refer to Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

nodegroupName

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

Sets the value of CfnNodegroupMixinProps.getNodegroupName()

Parameters:

nodegroupName - The unique name to give your node group.

Returns:

this

nodeRepairConfig

@Stability(Stable)
public CfnNodegroupMixinProps.Builder nodeRepairConfig(IResolvable nodeRepairConfig)

Sets the value of CfnNodegroupMixinProps.getNodeRepairConfig()

Parameters:

nodeRepairConfig - The node auto repair configuration for the node group.

Returns:

this

nodeRepairConfig

@Stability(Stable)
public CfnNodegroupMixinProps.Builder nodeRepairConfig(CfnNodegroupPropsMixin.NodeRepairConfigProperty nodeRepairConfig)

Sets the value of CfnNodegroupMixinProps.getNodeRepairConfig()

Parameters:

nodeRepairConfig - The node auto repair configuration for the node group.

Returns:

this

nodeRole

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

Sets the value of CfnNodegroupMixinProps.getNodeRole()

Parameters:

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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

nodeRole

@Stability(Stable)
public CfnNodegroupMixinProps.Builder nodeRole(IRoleRef nodeRole)

Sets the value of CfnNodegroupMixinProps.getNodeRole()

Parameters:

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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

releaseVersion

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

Sets the value of CfnNodegroupMixinProps.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 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 .

Returns:

this

remoteAccess

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

Sets the value of CfnNodegroupMixinProps.getRemoteAccess()

Parameters:

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

remoteAccess

@Stability(Stable)
public CfnNodegroupMixinProps.Builder remoteAccess(CfnNodegroupPropsMixin.RemoteAccessProperty remoteAccess)

Sets the value of CfnNodegroupMixinProps.getRemoteAccess()

Parameters:

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 Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

scalingConfig

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

Sets the value of CfnNodegroupMixinProps.getScalingConfig()

Parameters:

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

Returns:

this

scalingConfig

@Stability(Stable)
public CfnNodegroupMixinProps.Builder scalingConfig(CfnNodegroupPropsMixin.ScalingConfigProperty scalingConfig)

Sets the value of CfnNodegroupMixinProps.getScalingConfig()

Parameters:

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

Returns:

this

subnets

@Stability(Stable)
public CfnNodegroupMixinProps.Builder subnets(List<? extends Object> subnets)

Sets the value of CfnNodegroupMixinProps.getSubnets()

Parameters:

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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide .

Returns:

this

tags

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

Sets the value of CfnNodegroupMixinProps.getTags()

Parameters:

tags - Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

Returns:

this

taints

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

Sets the value of CfnNodegroupMixinProps.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(Stable)
public CfnNodegroupMixinProps.Builder taints(List<? extends Object> taints)

Sets the value of CfnNodegroupMixinProps.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(Stable)
public CfnNodegroupMixinProps.Builder updateConfig(IResolvable updateConfig)

Sets the value of CfnNodegroupMixinProps.getUpdateConfig()

Parameters:

updateConfig - The node group update configuration.

Returns:

this

updateConfig

@Stability(Stable)
public CfnNodegroupMixinProps.Builder updateConfig(CfnNodegroupPropsMixin.UpdateConfigProperty updateConfig)

Sets the value of CfnNodegroupMixinProps.getUpdateConfig()

Parameters:

updateConfig - The node group update configuration.

Returns:

this

version

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

Sets the value of CfnNodegroupMixinProps.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 .

You can't update other properties at the same time as updating Version .

Returns:

this

build

@Stability(Stable)
public CfnNodegroupMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnNodegroupMixinProps

Throws:

NullPointerException - if any required attribute was not provided