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(Stable) public static final class CfnNodegroupProps.Builder extends Object implements software.amazon.jsii.Builder<CfnNodegroupProps>
A builder for CfnNodegroupProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • clusterName

      @Stability(Stable) public CfnNodegroupProps.Builder clusterName(String clusterName)
      Parameters:
      clusterName - The name of your cluster. This parameter is required.
      Returns:
      this
    • nodeRole

      @Stability(Stable) public CfnNodegroupProps.Builder nodeRole(String nodeRole)
      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](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
    • subnets

      @Stability(Stable) public CfnNodegroupProps.Builder subnets(List<String> subnets)
      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](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
    • amiType

      @Stability(Stable) public CfnNodegroupProps.Builder amiType(String amiType)
      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 CfnNodegroupProps.Builder capacityType(String capacityType)
      Parameters:
      capacityType - The capacity type of your managed node group.
      Returns:
      this
    • diskSize

      @Stability(Stable) public CfnNodegroupProps.Builder diskSize(Number diskSize)
      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 CfnNodegroupProps.Builder forceUpdateEnabled(Boolean forceUpdateEnabled)
      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 CfnNodegroupProps.Builder forceUpdateEnabled(IResolvable forceUpdateEnabled)
      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 CfnNodegroupProps.Builder instanceTypes(List<String> instanceTypes)
      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 CfnNodegroupProps.Builder labels(IResolvable labels)
      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 CfnNodegroupProps.Builder labels(Map<String,String> labels)
      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 CfnNodegroupProps.Builder launchTemplate(IResolvable launchTemplate)
      Parameters:
      launchTemplate - An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . 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 CfnNodegroupProps.Builder launchTemplate(CfnNodegroup.LaunchTemplateSpecificationProperty launchTemplate)
      Parameters:
      launchTemplate - An object representing a node group's launch template specification. When using this object, don't directly specify instanceTypes , diskSize , or remoteAccess . 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 CfnNodegroupProps.Builder nodegroupName(String nodegroupName)
      Parameters:
      nodegroupName - The unique name to give your node group.
      Returns:
      this
    • releaseVersion

      @Stability(Stable) public CfnNodegroupProps.Builder releaseVersion(String releaseVersion)
      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 CfnNodegroupProps.Builder remoteAccess(IResolvable remoteAccess)
      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 CfnNodegroupProps.Builder remoteAccess(CfnNodegroup.RemoteAccessProperty remoteAccess)
      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 CfnNodegroupProps.Builder scalingConfig(IResolvable scalingConfig)
      Parameters:
      scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group.
      Returns:
      this
    • scalingConfig

      @Stability(Stable) public CfnNodegroupProps.Builder scalingConfig(CfnNodegroup.ScalingConfigProperty scalingConfig)
      Parameters:
      scalingConfig - The scaling configuration details for the Auto Scaling group that is created for your node group.
      Returns:
      this
    • tags

      @Stability(Stable) public CfnNodegroupProps.Builder tags(Map<String,String> tags)
      Sets the value of CfnNodegroupProps.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 CfnNodegroupProps.Builder taints(IResolvable taints)
      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 CfnNodegroupProps.Builder taints(List<? extends Object> taints)
      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 CfnNodegroupProps.Builder updateConfig(IResolvable updateConfig)
      Parameters:
      updateConfig - The node group update configuration.
      Returns:
      this
    • updateConfig

      @Stability(Stable) public CfnNodegroupProps.Builder updateConfig(CfnNodegroup.UpdateConfigProperty updateConfig)
      Parameters:
      updateConfig - The node group update configuration.
      Returns:
      this
    • version

      @Stability(Stable) public CfnNodegroupProps.Builder version(String version)
      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 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