Interface IWarmPoolOptions

Options for a warm pool.

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.AWS.AutoScaling.dll

Syntax (csharp)

public interface IWarmPoolOptions

Syntax (vb)

Public Interface IWarmPoolOptions

Remarks

ExampleMetadata: infused

Examples

AutoScalingGroup autoScalingGroup;


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

Synopsis

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.

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.

virtual Nullable<double> MaxGroupPreparedCapacity { get; }

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.

virtual Nullable<double> MinSize { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: 0

PoolState

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

virtual Nullable<PoolState> PoolState { get; }

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.

virtual Nullable<bool> ReuseOnScaleIn { get; }

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