Package software.amazon.awssdk.services.autoscaling.model

Class PutWarmPoolRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

software.amazon.awssdk.services.autoscaling.model.PutWarmPoolRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutWarmPoolRequest
extends AutoScalingRequest
implements ToCopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutWarmPoolRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	autoScalingGroupName()	The name of the Auto Scaling group.
static PutWarmPoolRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InstanceReusePolicy	instanceReusePolicy()	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
Integer	maxGroupPreparedCapacity()	Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.
Integer	minSize()	Specifies the minimum number of instances to maintain in the warm pool.
WarmPoolState	poolState()	Sets the instance state to transition to after the lifecycle actions are complete.
String	poolStateAsString()	Sets the instance state to transition to after the lifecycle actions are complete.
List<SdkField<?>>	sdkFields()
static Class<? extends PutWarmPoolRequest.Builder>	serializableBuilderClass()
PutWarmPoolRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

autoScalingGroupName

public final String autoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

maxGroupPreparedCapacity

public final Integer maxGroupPreparedCapacity()

Specifies the 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 you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

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, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

Returns:

Specifies the 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 you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

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, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.

minSize

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

Returns:

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.

poolState

public final WarmPoolState poolState()

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

If the service returns an enum value that is not available in the current SDK version, poolState will return WarmPoolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from poolStateAsString().

Returns:

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

See Also:

WarmPoolState

poolStateAsString

public final String poolStateAsString()

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

If the service returns an enum value that is not available in the current SDK version, poolState will return WarmPoolState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from poolStateAsString().

Returns:

Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

See Also:

WarmPoolState

instanceReusePolicy

public final InstanceReusePolicy instanceReusePolicy()

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.

Returns:

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.

toBuilder

public PutWarmPoolRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutWarmPoolRequest.Builder,PutWarmPoolRequest>

Specified by:

toBuilder in class AutoScalingRequest

builder

public static PutWarmPoolRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo