Interface ICfnWarmPoolProps

Namespace

Amazon.CDK.AWS.AutoScaling

Assembly

Amazon.CDK.AWS.AutoScaling.dll

Properties for defining a CfnWarmPool.

public interface ICfnWarmPoolProps

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;

             var cfnWarmPoolProps = new CfnWarmPoolProps {
                 AutoScalingGroupName = "autoScalingGroupName",

                 // the properties below are optional
                 InstanceReusePolicy = new InstanceReusePolicyProperty {
                     ReuseOnScaleIn = false
                 },
                 MaxGroupPreparedCapacity = 123,
                 MinSize = 123,
                 PoolState = "poolState"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html

ExampleMetadata: fixture=_generated

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

string AutoScalingGroupName { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-autoscalinggroupname

InstanceReusePolicy

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

object? InstanceReusePolicy { get; }

Property Value

object

Remarks

The default is to terminate instances in the Auto Scaling group when the group scales in.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-instancereusepolicy

MaxGroupPreparedCapacity

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

double? MaxGroupPreparedCapacity { get; }

Property Value

double?

Remarks

This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for <code>MaxGroupPreparedCapacity</code> is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for <code>MaxGroupPreparedCapacity</code> , Amazon EC2 Auto Scaling uses the difference between the <code>MaxGroupPreparedCapacity</code> and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity , the capacity of the warm pool is 0, unless you specify a value for MinSize . To remove a value that you previously set, include the property but specify -1 for the value.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-maxgrouppreparedcapacity

MinSize

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

double? MinSize { get; }

Property Value

double?

Remarks

This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-minsize

PoolState

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

string? PoolState { get; }

Property Value

string

Remarks

Default is Stopped .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-poolstate