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

Class NodegroupScalingConfig

java.lang.Object

software.amazon.awssdk.services.eks.model.NodegroupScalingConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>

@Generated("software.amazon.awssdk:codegen")
public final class NodegroupScalingConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. When creating a node group, you must specify all or none of the properties. When updating a node group, you can specify any or none of the properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodegroupScalingConfig.Builder

Method Summary

Modifier and Type	Method	Description
static NodegroupScalingConfig.Builder	builder()
Integer	desiredSize()	The current number of nodes that the managed node group should maintain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxSize()	The maximum number of nodes that the managed node group can scale out to.
Integer	minSize()	The minimum number of nodes that the managed node group can scale in to.
List<SdkField<?>>	sdkFields()
static Class<? extends NodegroupScalingConfig.Builder>	serializableBuilderClass()
NodegroupScalingConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

minSize

public final Integer minSize()

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

Returns:

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

maxSize

public final 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.

Returns:

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.

desiredSize

public final Integer desiredSize()

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

If you use the Kubernetes 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 the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

Returns:

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

If you use the Kubernetes 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 the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

toBuilder

public NodegroupScalingConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodegroupScalingConfig.Builder,NodegroupScalingConfig>

builder

public static NodegroupScalingConfig.Builder builder()

serializableBuilderClass

public static Class<? extends NodegroupScalingConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo