WarmPool

class aws_cdk.aws_autoscaling.WarmPool(scope, id, *, auto_scaling_group, max_group_prepared_capacity=None, min_size=None, pool_state=None, reuse_on_scale_in=None)

Bases: Resource

Define a warm pool.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_autoscaling as autoscaling

# auto_scaling_group: autoscaling.AutoScalingGroup

warm_pool = autoscaling.WarmPool(self, "MyWarmPool",
    auto_scaling_group=auto_scaling_group,

    # the properties below are optional
    max_group_prepared_capacity=123,
    min_size=123,
    pool_state=autoscaling.PoolState.HIBERNATED,
    reuse_on_scale_in=False
)

Parameters:

scope (Construct)
id (str)
auto_scaling_group (IAutoScalingGroup) – The Auto Scaling group to add the warm pool to.
max_group_prepared_capacity (Union[int, float, None]) – 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. 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
min_size (Union[int, float, None]) – The minimum number of instances to maintain in the warm pool. Default: 0
pool_state (Optional[PoolState]) – The instance state to transition to after the lifecycle actions are complete. Default: PoolState.STOPPED
reuse_on_scale_in (Optional[bool]) – Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. If the value is not specified, instances in the Auto Scaling group will be terminated when the group scales in. Default: false

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool