software.amazon.awssdk.services.autoscaling.model

Interface PutWarmPoolRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>, SdkBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutWarmPoolRequest

public static interface PutWarmPoolRequest.Builder
extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>

Method Summary

Modifier and Type	Method and Description
PutWarmPoolRequest.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
PutWarmPoolRequest.Builder	maxGroupPreparedCapacity(Integer maxGroupPreparedCapacity) Specifies the total maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.
PutWarmPoolRequest.Builder	minSize(Integer minSize) Specifies the minimum number of instances to maintain in the warm pool.
PutWarmPoolRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutWarmPoolRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutWarmPoolRequest.Builder	poolState(String poolState) Sets the instance state to transition to after the lifecycle hooks finish.
PutWarmPoolRequest.Builder	poolState(WarmPoolState poolState) Sets the instance state to transition to after the lifecycle hooks finish.

Methods inherited from interface software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

autoScalingGroupName

PutWarmPoolRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

maxGroupPreparedCapacity

PutWarmPoolRequest.Builder maxGroupPreparedCapacity(Integer maxGroupPreparedCapacity)

Specifies the total maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if the warm pool size should not be determined by the difference between the group's maximum capacity and its desired capacity.

Amazon EC2 Auto Scaling will launch and maintain either the difference between the group's maximum capacity and its desired capacity, if a value for MaxGroupPreparedCapacity is not specified, or the difference between the MaxGroupPreparedCapacity and the desired capacity, if a value for MaxGroupPreparedCapacity is specified.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0. To remove a value that you previously set, include the property but specify -1 for the value.

Parameters:

maxGroupPreparedCapacity - Specifies the total maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if the warm pool size should not be determined by the difference between the group's maximum capacity and its desired capacity.

Amazon EC2 Auto Scaling will launch and maintain either the difference between the group's maximum capacity and its desired capacity, if a value for MaxGroupPreparedCapacity is not specified, or the difference between the MaxGroupPreparedCapacity and the desired capacity, if a value for MaxGroupPreparedCapacity is specified.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0. To remove a value that you previously set, include the property but specify -1 for the value.

Returns:

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

minSize

PutWarmPoolRequest.Builder minSize(Integer minSize)

Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Parameters:

minSize - Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Returns:

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

poolState

PutWarmPoolRequest.Builder poolState(String poolState)

Sets the instance state to transition to after the lifecycle hooks finish. Valid values are: Stopped (default) or Running.

Parameters:

poolState - Sets the instance state to transition to after the lifecycle hooks finish. Valid values are: Stopped (default) or Running.

Returns:

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

See Also:

WarmPoolState, WarmPoolState

poolState

PutWarmPoolRequest.Builder poolState(WarmPoolState poolState)

Sets the instance state to transition to after the lifecycle hooks finish. Valid values are: Stopped (default) or Running.

Parameters:

poolState - Sets the instance state to transition to after the lifecycle hooks finish. Valid values are: Stopped (default) or Running.

Returns:

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

See Also:

WarmPoolState, WarmPoolState

overrideConfiguration

PutWarmPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutWarmPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder