Class CfnWarmPool

The AWS::AutoScaling::WarmPool resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWarmPool

Implements

IInspectable

IWarmPoolRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AutoScaling

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWarmPool : CfnResource, IInspectable, IWarmPoolRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnWarmPool Inherits CfnResource Implements IInspectable, IWarmPoolRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

When you create a warm pool, you can define a minimum size. When your Auto Scaling group scales out and the size of the warm pool shrinks, Amazon EC2 Auto Scaling launches new instances into the warm pool to maintain its minimum size.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

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;

             var cfnWarmPool = new CfnWarmPool(this, "MyCfnWarmPool", new CfnWarmPoolProps {
                 AutoScalingGroupName = "autoScalingGroupName",

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

Synopsis

Constructors

CfnWarmPool(Construct, string, ICfnWarmPoolProps)

Create a new AWS::AutoScaling::WarmPool.

Properties

AutoScalingGroupName	The name of the Auto Scaling group.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::AutoScaling::WarmPool` resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group.
InstanceReusePolicy	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
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.
MinSize	Specifies the minimum number of instances to maintain in the warm pool.
PoolState	Sets the instance state to transition to after the lifecycle actions are complete.
WarmPoolRef	A reference to a WarmPool resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWarmPool(object)	Checks whether the given object is a CfnWarmPool.
RenderProperties(IDictionary<string, object>)	The `AWS::AutoScaling::WarmPool` resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group.

Constructors

CfnWarmPool(Construct, string, ICfnWarmPoolProps)

Create a new AWS::AutoScaling::WarmPool.

public CfnWarmPool(Construct scope, string id, ICfnWarmPoolProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnWarmPoolProps: Resource properties.

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

public virtual string AutoScalingGroupName { get; set; }

Property Value

string

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AutoScaling::WarmPool resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

InstanceReusePolicy

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

public virtual object? InstanceReusePolicy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnWarmPool.IInstanceReusePolicyProperty

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.

public virtual double? MaxGroupPreparedCapacity { get; set; }

Property Value

double?

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

MinSize

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

public virtual double? MinSize { get; set; }

Property Value

double?

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

PoolState

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

public virtual string? PoolState { get; set; }

Property Value

string

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

WarmPoolRef

A reference to a WarmPool resource.

public virtual IWarmPoolReference WarmPoolRef { get; }

Property Value

IWarmPoolReference

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

IsCfnWarmPool(object)

Checks whether the given object is a CfnWarmPool.

public static bool IsCfnWarmPool(object x)

Parameters

x object

Returns

bool

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AutoScaling::WarmPool resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity.

For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .

CloudFormation supports the <code>UpdatePolicy</code> attribute for Auto Scaling groups. During an update, if <code>UpdatePolicy</code> is set to <code>AutoScalingRollingUpdate</code> , CloudFormation replaces <code>InService</code> instances only. Instances in the warm pool are not replaced. The difference in which instances are replaced can potentially result in different instance configurations after the stack update completes. If <code>UpdatePolicy</code> is set to <code>AutoScalingReplacingUpdate</code> , you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.

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

CloudformationResource: AWS::AutoScaling::WarmPool

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWarmPoolRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware