software.amazon.awssdk.services.eks.model

Interface NodegroupScalingConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>, SdkBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>, SdkPojo

Enclosing class:

NodegroupScalingConfig

public static interface NodegroupScalingConfig.Builder
extends SdkPojo, CopyableBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>

Method Summary

Modifier and Type	Method and Description
NodegroupScalingConfig.Builder	desiredSize(Integer desiredSize) The current number of nodes that the managed node group should maintain.
NodegroupScalingConfig.Builder	maxSize(Integer maxSize) The maximum number of nodes that the managed node group can scale out to.
NodegroupScalingConfig.Builder	minSize(Integer minSize) The minimum number of nodes that the managed node group can scale in to.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

minSize

NodegroupScalingConfig.Builder minSize(Integer minSize)

The minimum number of nodes that the managed node group can scale in to.

Parameters:

minSize - The minimum number of nodes that the managed node group can scale in to.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxSize

NodegroupScalingConfig.Builder maxSize(Integer maxSize)

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

Parameters:

maxSize - The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

desiredSize

NodegroupScalingConfig.Builder desiredSize(Integer desiredSize)

The current number of nodes that the managed node group should maintain.

If you use Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler (but can be out-of-date for short periods of time). Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

Parameters:

desiredSize - The current number of nodes that the managed node group should maintain.

If you use Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler (but can be out-of-date for short periods of time). Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

Returns:

Returns a reference to this object so that method calls can be chained together.