Package software.amazon.awssdk.services.eks.model

Interface Nodegroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Nodegroup.Builder,Nodegroup>, SdkBuilder<Nodegroup.Builder,Nodegroup>, SdkPojo
Enclosing class:
Nodegroup
public static interface Nodegroup.Builder extends SdkPojo, CopyableBuilder<Nodegroup.Builder,Nodegroup>

  • Method Details

    • nodegroupName

      Nodegroup.Builder nodegroupName(String nodegroupName)

      The name associated with an Amazon EKS managed node group.

      Parameters:
      nodegroupName - The name associated with an Amazon EKS managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodegroupArn

      Nodegroup.Builder nodegroupArn(String nodegroupArn)

      The Amazon Resource Name (ARN) associated with the managed node group.

      Parameters:
      nodegroupArn - The Amazon Resource Name (ARN) associated with the managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      Nodegroup.Builder clusterName(String clusterName)

      The name of the cluster that the managed node group resides in.

      Parameters:
      clusterName - The name of the cluster that the managed node group resides in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      Nodegroup.Builder version(String version)

      The Kubernetes version of the managed node group.

      Parameters:
      version - The Kubernetes version of the managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseVersion

      Nodegroup.Builder releaseVersion(String releaseVersion)

      If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

      Parameters:
      releaseVersion - If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Nodegroup.Builder createdAt(Instant createdAt)

      The Unix epoch timestamp in seconds for when the managed node group was created.

      Parameters:
      createdAt - The Unix epoch timestamp in seconds for when the managed node group was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      Nodegroup.Builder modifiedAt(Instant modifiedAt)

      The Unix epoch timestamp in seconds for when the managed node group was last modified.

      Parameters:
      modifiedAt - The Unix epoch timestamp in seconds for when the managed node group was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Nodegroup.Builder status(String status)

      The current status of the managed node group.

      Parameters:
      status - The current status of the managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Nodegroup.Builder status(NodegroupStatus status)

      The current status of the managed node group.

      Parameters:
      status - The current status of the managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capacityType

      Nodegroup.Builder capacityType(String capacityType)

      The capacity type of your managed node group.

      Parameters:
      capacityType - The capacity type of your managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capacityType

      Nodegroup.Builder capacityType(CapacityTypes capacityType)

      The capacity type of your managed node group.

      Parameters:
      capacityType - The capacity type of your managed node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scalingConfig

      Nodegroup.Builder scalingConfig(NodegroupScalingConfig scalingConfig)

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

      Parameters:
      scalingConfig - The scaling configuration details for the Auto Scaling group that is associated with your node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingConfig

      default Nodegroup.Builder scalingConfig(Consumer<NodegroupScalingConfig.Builder> scalingConfig)

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

      This is a convenience method that creates an instance of the NodegroupScalingConfig.Builder avoiding the need to create one manually via NodegroupScalingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfig(NodegroupScalingConfig).

      Parameters:
      scalingConfig - a consumer that will call methods on NodegroupScalingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceTypes

      Nodegroup.Builder instanceTypes(Collection<String> instanceTypes)

      If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

      Parameters:
      instanceTypes - If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceTypes

      Nodegroup.Builder instanceTypes(String... instanceTypes)

      If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

      Parameters:
      instanceTypes - If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnets

      Nodegroup.Builder subnets(Collection<String> subnets)

      The subnets that were specified for the Auto Scaling group that is associated with your node group.

      Parameters:
      subnets - The subnets that were specified for the Auto Scaling group that is associated with your node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnets

      Nodegroup.Builder subnets(String... subnets)

      The subnets that were specified for the Auto Scaling group that is associated with your node group.

      Parameters:
      subnets - The subnets that were specified for the Auto Scaling group that is associated with your node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteAccess

      Nodegroup.Builder remoteAccess(RemoteAccessConfig remoteAccess)

      If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

      Parameters:
      remoteAccess - If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remoteAccess

      default Nodegroup.Builder remoteAccess(Consumer<RemoteAccessConfig.Builder> remoteAccess)

      If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

      This is a convenience method that creates an instance of the RemoteAccessConfig.Builder avoiding the need to create one manually via RemoteAccessConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to remoteAccess(RemoteAccessConfig).

      Parameters:
      remoteAccess - a consumer that will call methods on RemoteAccessConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • amiType

      Nodegroup.Builder amiType(String amiType)

      If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

      Parameters:
      amiType - If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • amiType

      Nodegroup.Builder amiType(AMITypes amiType)

      If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

      Parameters:
      amiType - If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeRole

      Nodegroup.Builder nodeRole(String nodeRole)

      The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.

      Parameters:
      nodeRole - The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labels

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

      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:
      Returns a reference to this object so that method calls can be chained together.

    • taints

      Nodegroup.Builder taints(Collection<Taint> 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • taints

      Nodegroup.Builder taints(Taint... 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. 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:
      Returns a reference to this object so that method calls can be chained together.

    • taints

      Nodegroup.Builder taints(Consumer<Taint.Builder>... 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.

      This is a convenience method that creates an instance of the Taint.Builder avoiding the need to create one manually via Taint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taints(List<Taint>).

      Parameters:
      taints - a consumer that will call methods on Taint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resources

      Nodegroup.Builder resources(NodegroupResources resources)

      The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

      Parameters:
      resources - The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      default Nodegroup.Builder resources(Consumer<NodegroupResources.Builder> resources)

      The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

      This is a convenience method that creates an instance of the NodegroupResources.Builder avoiding the need to create one manually via NodegroupResources.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resources(NodegroupResources).

      Parameters:
      resources - a consumer that will call methods on NodegroupResources.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • diskSize

      Nodegroup.Builder diskSize(Integer diskSize)

      If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.

      Parameters:
      diskSize - If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • health

      Nodegroup.Builder health(NodegroupHealth health)

      The health status of the node group. If there are issues with your node group's health, they are listed here.

      Parameters:
      health - The health status of the node group. If there are issues with your node group's health, they are listed here.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • health

      default Nodegroup.Builder health(Consumer<NodegroupHealth.Builder> health)

      The health status of the node group. If there are issues with your node group's health, they are listed here.

      This is a convenience method that creates an instance of the NodegroupHealth.Builder avoiding the need to create one manually via NodegroupHealth.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to health(NodegroupHealth).

      Parameters:
      health - a consumer that will call methods on NodegroupHealth.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updateConfig

      Nodegroup.Builder updateConfig(NodegroupUpdateConfig updateConfig)

      The node group update configuration.

      Parameters:
      updateConfig - The node group update configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateConfig

      default Nodegroup.Builder updateConfig(Consumer<NodegroupUpdateConfig.Builder> updateConfig)

      The node group update configuration.

      This is a convenience method that creates an instance of the NodegroupUpdateConfig.Builder avoiding the need to create one manually via NodegroupUpdateConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updateConfig(NodegroupUpdateConfig).

      Parameters:
      updateConfig - a consumer that will call methods on NodegroupUpdateConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • launchTemplate

      Nodegroup.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)

      If a launch template was used to create the node group, then this is the launch template that was used.

      Parameters:
      launchTemplate - If a launch template was used to create the node group, then this is the launch template that was used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchTemplate

      default Nodegroup.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)

      If a launch template was used to create the node group, then this is the launch template that was used.

      This is a convenience method that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplate(LaunchTemplateSpecification).

      Parameters:
      launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Nodegroup.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. 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:
      Returns a reference to this object so that method calls can be chained together.