Package software.amazon.awscdk.services.autoscaling

Interface WarmPoolOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

WarmPoolProps

All Known Implementing Classes:

WarmPoolOptions.Jsii$Proxy, WarmPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:21.817Z")
@Stability(Stable)
public interface WarmPoolOptions
extends software.amazon.jsii.JsiiSerializable

Options for a warm pool.

Example:

 AutoScalingGroup autoScalingGroup;
 autoScalingGroup.addWarmPool(WarmPoolOptions.builder()
         .minSize(1)
         .reuseOnScaleIn(true)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WarmPoolOptions.Builder	A builder for WarmPoolOptions
static final class	WarmPoolOptions.Jsii$Proxy	An implementation for WarmPoolOptions

Method Summary

Modifier and Type	Method	Description
static WarmPoolOptions.Builder	builder()
default Number	getMaxGroupPreparedCapacity()	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.
default Number	getMinSize()	The minimum number of instances to maintain in the warm pool.
default PoolState	getPoolState()	The instance state to transition to after the lifecycle actions are complete.
default Boolean	getReuseOnScaleIn()	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxGroupPreparedCapacity

@Stability(Stable)
@Nullable
default Number getMaxGroupPreparedCapacity()

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.

If the value is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity.

Default: - max size of the Auto Scaling group

getMinSize

@Stability(Stable)
@Nullable
default Number getMinSize()

The minimum number of instances to maintain in the warm pool.

Default: 0

getPoolState

@Stability(Stable)
@Nullable
default PoolState getPoolState()

The instance state to transition to after the lifecycle actions are complete.

Default: PoolState.STOPPED

getReuseOnScaleIn

@Stability(Stable)
@Nullable
default Boolean getReuseOnScaleIn()

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

If the value is not specified, instances in the Auto Scaling group will be terminated when the group scales in.

Default: false

builder

@Stability(Stable)
static WarmPoolOptions.Builder builder()

Returns:

a WarmPoolOptions.Builder of WarmPoolOptions