Class WarmPoolOptions

Options for a warm pool.

Inheritance
System.Object
WarmPoolOptions
Implements
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WarmPoolOptions : Object, IWarmPoolOptions
Syntax (vb)
Public Class WarmPoolOptions
    Inherits Object
    Implements IWarmPoolOptions
Remarks

ExampleMetadata: infused

Examples
AutoScalingGroup autoScalingGroup;


autoScalingGroup.AddWarmPool(new WarmPoolOptions {
    MinSize = 1,
    ReuseOnScaleIn = true
});

Synopsis

Constructors

WarmPoolOptions()

Properties

MaxGroupPreparedCapacity

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.
MinSize

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

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

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

Constructors

WarmPoolOptions()

public WarmPoolOptions()

Properties

MaxGroupPreparedCapacity

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.

public Nullable<double> MaxGroupPreparedCapacity { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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

MinSize

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

public Nullable<double> MinSize { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

Default: 0

PoolState

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

public Nullable<PoolState> PoolState { get; set; }
Property Value

System.Nullable<PoolState>

Remarks

Default: PoolState.STOPPED

ReuseOnScaleIn

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

public Nullable<bool> ReuseOnScaleIn { get; set; }
Property Value

System.Nullable<System.Boolean>

Remarks

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

Default: false

Implements