software.amazon.awscdk.services.autoscaling

Interface WarmPoolOptions

All Known Subinterfaces:

WarmPoolProps

All Known Implementing Classes:

WarmPoolOptions.Jsii$Proxy, WarmPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.035Z")
public interface WarmPoolOptions

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 and Description
static class	WarmPoolOptions.Builder A builder for WarmPoolOptions
static class	WarmPoolOptions.Jsii$Proxy An implementation for WarmPoolOptions

Method Summary

Modifier and Type	Method and Description
static WarmPoolOptions.Builder	builder()
default java.lang.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 java.lang.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 java.lang.Boolean	getReuseOnScaleIn() Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

Method Detail

getMaxGroupPreparedCapacity

default java.lang.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

default java.lang.Number getMinSize()

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

Default: 0

getPoolState

default PoolState getPoolState()

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

Default: PoolState.STOPPED

getReuseOnScaleIn

default java.lang.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

static WarmPoolOptions.Builder builder()

Returns:

a WarmPoolOptions.Builder of WarmPoolOptions