CfnNodegroup.Builder

java.lang.Object
- software.amazon.awscdk.services.eks.legacy.CfnNodegroup.Builder

Enclosing class:: CfnNodegroup

public static final class CfnNodegroup.Builder
extends java.lang.Object

A fluent builder for CfnNodegroup.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnNodegroup.Builder`	`amiType(java.lang.String amiType)` The AMI type for your node group.
`CfnNodegroup`	`build()`
`CfnNodegroup.Builder`	`capacityType(java.lang.String capacityType)` The capacity type of your managed node group.
`CfnNodegroup.Builder`	`clusterName(java.lang.String clusterName)` The name of the cluster to create the node group in.
`static CfnNodegroup.Builder`	`create(Construct scope, java.lang.String id)`
`CfnNodegroup.Builder`	`diskSize(java.lang.Number diskSize)` The root device disk size (in GiB) for your node group instances.
`CfnNodegroup.Builder`	`forceUpdateEnabled(java.lang.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(java.util.List<java.lang.String> instanceTypes)` Specify the instance types for a node group.
`CfnNodegroup.Builder`	`labels(java.lang.Object labels)` The Kubernetes labels to be applied to the nodes in the node group when they are created.
`CfnNodegroup.Builder`	`launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate)` An object representing a node group's launch template specification.
`CfnNodegroup.Builder`	`launchTemplate(IResolvable launchTemplate)` An object representing a node group's launch template specification.
`CfnNodegroup.Builder`	`nodegroupName(java.lang.String nodegroupName)` The unique name to give your node group.
`CfnNodegroup.Builder`	`nodeRole(java.lang.String nodeRole)` The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
`CfnNodegroup.Builder`	`releaseVersion(java.lang.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(CfnNodegroup.RemoteAccessProperty remoteAccess)` The remote access (SSH) configuration to use with your node group.
`CfnNodegroup.Builder`	`remoteAccess(IResolvable remoteAccess)` The remote access (SSH) configuration to use with 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`	`scalingConfig(IResolvable scalingConfig)` The scaling configuration details for the Auto Scaling group that is created for your node group.
`CfnNodegroup.Builder`	`subnets(java.util.List<java.lang.String> subnets)` The subnets to use for the Auto Scaling group that is created for your node group.
`CfnNodegroup.Builder`	`tags(java.lang.Object tags)` The metadata to apply to the node group to assist with categorization and organization.
`CfnNodegroup.Builder`	`taints(IResolvable taints)` The Kubernetes taints to be applied to the nodes in the node group when they are created.
`CfnNodegroup.Builder`	`taints(java.util.List<? extends java.lang.Object> taints)` The Kubernetes taints to be applied to the nodes in the node group when they are created.
`CfnNodegroup.Builder`	`updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig)` The node group update configuration.
`CfnNodegroup.Builder`	`updateConfig(IResolvable updateConfig)` The node group update configuration.
`CfnNodegroup.Builder`	`version(java.lang.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 Detail
  - create
```
public static CfnNodegroup.Builder create(Construct scope,
                                          java.lang.String id)
```
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    Returns:
    
    a new instance of CfnNodegroup.LaunchTemplateSpecificationProperty.Builder.
  - clusterName
```
public CfnNodegroup.Builder clusterName(java.lang.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
  - nodeRole
```
public CfnNodegroup.Builder nodeRole(java.lang.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
  - subnets
```
public CfnNodegroup.Builder subnets(java.util.List<java.lang.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
  - amiType
```
public CfnNodegroup.Builder amiType(java.lang.String 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 .
    
    Parameters:
    
    amiType - The AMI type for your node group. This parameter is required.
    
    Returns:
    
    this
  - capacityType
```
public CfnNodegroup.Builder capacityType(java.lang.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
  - diskSize
```
public CfnNodegroup.Builder diskSize(java.lang.Number 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 .
    
    Parameters:
    
    diskSize - The root device disk size (in GiB) for your node group instances. This parameter is required.
    
    Returns:
    
    this
  - forceUpdateEnabled
```
public CfnNodegroup.Builder forceUpdateEnabled(java.lang.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.
    
    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
  - forceUpdateEnabled
```
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.
    
    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
  - instanceTypes
```
public CfnNodegroup.Builder instanceTypes(java.util.List<java.lang.String> 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 .
    
    Parameters:
    
    instanceTypes - Specify the instance types for a node group. This parameter is required.
    
    Returns:
    
    this
  - labels
```
public CfnNodegroup.Builder labels(java.lang.Object labels)
```
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    
    Parameters:
    
    labels - The Kubernetes labels to be applied to the nodes in the node group when they are created. This parameter is required.
    
    Returns:
    
    this
  - launchTemplate
```
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
  - launchTemplate
```
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
  - nodegroupName
```
public CfnNodegroup.Builder nodegroupName(java.lang.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
  - releaseVersion
```
public CfnNodegroup.Builder releaseVersion(java.lang.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](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.
    
    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* . This parameter is required.
    
    Returns:
    
    this
  - remoteAccess
```
public CfnNodegroup.Builder remoteAccess(IResolvable 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 .
    
    Parameters:
    
    remoteAccess - The remote access (SSH) configuration to use with your node group. This parameter is required.
    
    Returns:
    
    this
  - remoteAccess
```
public CfnNodegroup.Builder remoteAccess(CfnNodegroup.RemoteAccessProperty 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 .
    
    Parameters:
    
    remoteAccess - The remote access (SSH) configuration to use with your node group. This parameter is required.
    
    Returns:
    
    this
  - scalingConfig
```
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
  - scalingConfig
```
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
  - tags
```
public CfnNodegroup.Builder tags(java.lang.Object 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.
    
    Parameters:
    
    tags - The metadata to apply to the node group to assist with categorization and organization. This parameter is required.
    
    Returns:
    
    this
  - taints
```
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
  - taints
```
public CfnNodegroup.Builder taints(java.util.List<? extends java.lang.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
  - updateConfig
```
public CfnNodegroup.Builder updateConfig(IResolvable updateConfig)
```
    The node group update configuration.
    
    Parameters:
    
    updateConfig - The node group update configuration. This parameter is required.
    
    Returns:
    
    this
  - updateConfig
```
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
  - version
```
public CfnNodegroup.Builder version(java.lang.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 .
    
    Parameters:
    
    version - The Kubernetes version to use for your managed nodes. This parameter is required.
    
    Returns:
    
    this
  - build
```
public CfnNodegroup build()
```

Class CfnNodegroup.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

clusterName

nodeRole

subnets

amiType

capacityType

diskSize

forceUpdateEnabled

forceUpdateEnabled

instanceTypes

labels

launchTemplate

launchTemplate

nodegroupName

releaseVersion

remoteAccess

remoteAccess

scalingConfig

scalingConfig

tags

taints

taints

updateConfig

updateConfig

version

build