Class CfnWarmPool
A CloudFormation AWS::AutoScaling::WarmPool
.
Inherited Members
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.AWS.AutoScaling.dll
Syntax (csharp)
public class CfnWarmPool : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWarmPool
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::AutoScaling::WarmPool
resource creates a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. 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 UpdatePolicy
attribute for Auto Scaling groups. During an update, if UpdatePolicy
is set to AutoScalingRollingUpdate
, CloudFormation replaces InService
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 UpdatePolicy
is set to AutoScalingReplacingUpdate
, you do not encounter this issue because CloudFormation replaces both the Auto Scaling group and the warm pool.
CloudformationResource: AWS::AutoScaling::WarmPool
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html
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 |
CfnWarmPool(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWarmPool(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AutoScalingGroupName | The name of the Auto Scaling group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnWarmPoolProps
- resource properties.
CfnWarmPool(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWarmPool(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWarmPool(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWarmPool(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AutoScalingGroupName
The name of the Auto Scaling group.
public virtual string AutoScalingGroupName { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.Object
Remarks
The default is to terminate instances in the Auto Scaling group when the group scales 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.
public virtual Nullable<double> MaxGroupPreparedCapacity { get; set; }
Property Value
System.Nullable<System.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 MaxGroupPreparedCapacity
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 MaxGroupPreparedCapacity
, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity
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.
MinSize
Specifies the minimum number of instances to maintain in the warm pool.
public virtual Nullable<double> MinSize { get; set; }
Property Value
System.Nullable<System.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.
PoolState
Sets the instance state to transition to after the lifecycle actions are complete.
public virtual string PoolState { get; set; }
Property Value
System.String
Remarks
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>