Class WarmPoolOptions

Options for a warm pool.

Inheritance

object

WarmPoolOptions

Implements

IWarmPoolOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class WarmPoolOptions : IWarmPoolOptions

Syntax (vb)

Public Class WarmPoolOptions Implements IWarmPoolOptions

Remarks

ExampleMetadata: infused

Examples

AutoScalingGroup autoScalingGroup;


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

Synopsis

Constructors

WarmPoolOptions()

Options for a warm pool.

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()

Options for a warm pool.

public WarmPoolOptions()

Remarks

ExampleMetadata: infused

Examples

AutoScalingGroup autoScalingGroup;


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

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 double? MaxGroupPreparedCapacity { get; set; }

Property Value

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 double? MinSize { get; set; }

Property Value

double?

Remarks

Default: 0

PoolState

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

public PoolState? PoolState { get; set; }

Property Value

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 bool? ReuseOnScaleIn { get; set; }

Property Value

bool?

Remarks

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

Default: false

Implements

IWarmPoolOptions