Package software.amazon.awscdk.cfnpropertymixins.services.eks

Class CfnNodegroupPropsMixin.ScalingConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.eks.CfnNodegroupPropsMixin.ScalingConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnNodegroupPropsMixin.ScalingConfigProperty>

Enclosing interface:

CfnNodegroupPropsMixin.ScalingConfigProperty

@Stability(Stable)
public static final class CfnNodegroupPropsMixin.ScalingConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnNodegroupPropsMixin.ScalingConfigProperty>

A builder for CfnNodegroupPropsMixin.ScalingConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnNodegroupPropsMixin.ScalingConfigProperty	build()	Builds the configured instance.
CfnNodegroupPropsMixin.ScalingConfigProperty.Builder	desiredSize(Number desiredSize)	Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getDesiredSize()
CfnNodegroupPropsMixin.ScalingConfigProperty.Builder	maxSize(Number maxSize)	Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getMaxSize()
CfnNodegroupPropsMixin.ScalingConfigProperty.Builder	minSize(Number minSize)	Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getMinSize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

desiredSize

@Stability(Stable)
public CfnNodegroupPropsMixin.ScalingConfigProperty.Builder desiredSize(Number desiredSize)

Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getDesiredSize()

Parameters:

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:

this

maxSize

@Stability(Stable)
public CfnNodegroupPropsMixin.ScalingConfigProperty.Builder maxSize(Number maxSize)

Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getMaxSize()

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:

this

minSize

@Stability(Stable)
public CfnNodegroupPropsMixin.ScalingConfigProperty.Builder minSize(Number minSize)

Sets the value of CfnNodegroupPropsMixin.ScalingConfigProperty.getMinSize()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnNodegroupPropsMixin.ScalingConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnNodegroupPropsMixin.ScalingConfigProperty>

Returns:

a new instance of CfnNodegroupPropsMixin.ScalingConfigProperty

Throws:

NullPointerException - if any required attribute was not provided