software.amazon.awscdk.services.autoscaling

Interface CfnWarmPoolProps

All Known Implementing Classes:

CfnWarmPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:27.202Z")
public interface CfnWarmPoolProps

Properties for defining a `CfnWarmPool`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 CfnWarmPoolProps cfnWarmPoolProps = CfnWarmPoolProps.builder()
         .autoScalingGroupName("autoScalingGroupName")
         // the properties below are optional
         .instanceReusePolicy(InstanceReusePolicyProperty.builder()
                 .reuseOnScaleIn(false)
                 .build())
         .maxGroupPreparedCapacity(123)
         .minSize(123)
         .poolState("poolState")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWarmPoolProps.Builder A builder for CfnWarmPoolProps
static class	CfnWarmPoolProps.Jsii$Proxy An implementation for CfnWarmPoolProps

Method Summary

Modifier and Type	Method and Description
static CfnWarmPoolProps.Builder	builder()
java.lang.String	getAutoScalingGroupName() The name of the Auto Scaling group.
default java.lang.Object	getInstanceReusePolicy() Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
default java.lang.Number	getMaxGroupPreparedCapacity() 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.
default java.lang.Number	getMinSize() Specifies the minimum number of instances to maintain in the warm pool.
default java.lang.String	getPoolState() Sets the instance state to transition to after the lifecycle actions are complete.

Method Detail

getAutoScalingGroupName

java.lang.String getAutoScalingGroupName()

The name of the Auto Scaling group.

getInstanceReusePolicy

default java.lang.Object getInstanceReusePolicy()

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

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

getMaxGroupPreparedCapacity

default java.lang.Number getMaxGroupPreparedCapacity()

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.

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.

getMinSize

default java.lang.Number getMinSize()

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

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.

getPoolState

default java.lang.String getPoolState()

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

Default is Stopped .

builder

static CfnWarmPoolProps.Builder builder()

Returns:

a CfnWarmPoolProps.Builder of CfnWarmPoolProps