Class WarmPoolProps

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

Properties for a warm pool.

public class WarmPoolProps : IWarmPoolProps, IWarmPoolOptions

Inheritance

object

WarmPoolProps

Implements

IWarmPoolProps

IWarmPoolOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AutoScaling;

            AutoScalingGroup autoScalingGroup;

            var warmPoolProps = new WarmPoolProps {
                AutoScalingGroup = autoScalingGroup,

                // the properties below are optional
                MaxGroupPreparedCapacity = 123,
                MinSize = 123,
                PoolState = PoolState.HIBERNATED,
                ReuseOnScaleIn = false
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

WarmPoolProps()

public WarmPoolProps()

Properties

AutoScalingGroup

The Auto Scaling group to add the warm pool to.

public IAutoScalingGroup AutoScalingGroup { get; set; }

Property Value

IAutoScalingGroup

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