Class WarmPoolProps
Properties for a warm pool.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class WarmPoolProps : Object, IWarmPoolProps, IWarmPoolOptions
Syntax (vb)
Public Class WarmPoolProps
Inherits Object
Implements IWarmPoolProps, IWarmPoolOptions
Remarks
ExampleMetadata: fixture=_generated
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
};
Synopsis
Constructors
WarmPoolProps() |
Properties
AutoScalingGroup | The Auto Scaling group to add the warm pool to. |
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
WarmPoolProps()
public WarmPoolProps()
Properties
AutoScalingGroup
The Auto Scaling group to add the warm pool to.
public IAutoScalingGroup AutoScalingGroup { get; set; }
Property Value
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