Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.PutWarmPool

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is 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. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.

Creating a Request

data PutWarmPool Source #

See: newPutWarmPool smart constructor.

Constructors

PutWarmPool'

Fields

instanceReusePolicy :: Maybe InstanceReusePolicy
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.
maxGroupPreparedCapacity :: Maybe Int
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.
minSize :: Maybe Natural
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.
poolState :: Maybe WarmPoolState
Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.
autoScalingGroupName :: Text
The name of the Auto Scaling group.

Instances

Instances details

ToHeaders PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods toHeaders :: PutWarmPool -> [Header] #
ToPath PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods toPath :: PutWarmPool -> ByteString #
ToQuery PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods toQuery :: PutWarmPool -> QueryString #
AWSRequest PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Associated Types type AWSResponse PutWarmPool # Methods request :: (Service -> Service) -> PutWarmPool -> Request PutWarmPool # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutWarmPool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutWarmPool))) #
Generic PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Associated Types type Rep PutWarmPool :: Type -> Type # Methods from :: PutWarmPool -> Rep PutWarmPool x # to :: Rep PutWarmPool x -> PutWarmPool #
Read PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods readsPrec :: Int -> ReadS PutWarmPool # readList :: ReadS [PutWarmPool] # readPrec :: ReadPrec PutWarmPool # readListPrec :: ReadPrec [PutWarmPool] #
Show PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods showsPrec :: Int -> PutWarmPool -> ShowS # show :: PutWarmPool -> String # showList :: [PutWarmPool] -> ShowS #
NFData PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods rnf :: PutWarmPool -> () #
Eq PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods (==) :: PutWarmPool -> PutWarmPool -> Bool # (/=) :: PutWarmPool -> PutWarmPool -> Bool #
Hashable PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods hashWithSalt :: Int -> PutWarmPool -> Int # hash :: PutWarmPool -> Int #
type AWSResponse PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool type AWSResponse PutWarmPool = PutWarmPoolResponse
type Rep PutWarmPool Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool type Rep PutWarmPool = D1 ('MetaData "PutWarmPool" "Amazonka.AutoScaling.PutWarmPool" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "PutWarmPool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceReusePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceReusePolicy)) :: S1 ('MetaSel ('Just "maxGroupPreparedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "minSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "poolState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WarmPoolState)) :: S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutWarmPool Source #

Arguments

:: Text	`PutWarmPool`
-> PutWarmPool

Create a value of PutWarmPool with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutWarmPool, putWarmPool_instanceReusePolicy - 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.

PutWarmPool, putWarmPool_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. 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.

PutWarmPool, putWarmPool_minSize - 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.

PutWarmPool, putWarmPool_poolState - Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.

PutWarmPool, putWarmPool_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

putWarmPool_instanceReusePolicy :: Lens' PutWarmPool (Maybe InstanceReusePolicy) Source #

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.

putWarmPool_maxGroupPreparedCapacity :: Lens' PutWarmPool (Maybe Int) Source #

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.

putWarmPool_minSize :: Lens' PutWarmPool (Maybe Natural) Source #

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.

putWarmPool_poolState :: Lens' PutWarmPool (Maybe WarmPoolState) Source #

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

putWarmPool_autoScalingGroupName :: Lens' PutWarmPool Text Source #

The name of the Auto Scaling group.

Destructuring the Response

data PutWarmPoolResponse Source #

See: newPutWarmPoolResponse smart constructor.

Constructors

PutWarmPoolResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Associated Types type Rep PutWarmPoolResponse :: Type -> Type # Methods from :: PutWarmPoolResponse -> Rep PutWarmPoolResponse x # to :: Rep PutWarmPoolResponse x -> PutWarmPoolResponse #
Read PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods readsPrec :: Int -> ReadS PutWarmPoolResponse # readList :: ReadS [PutWarmPoolResponse] # readPrec :: ReadPrec PutWarmPoolResponse # readListPrec :: ReadPrec [PutWarmPoolResponse] #
Show PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods showsPrec :: Int -> PutWarmPoolResponse -> ShowS # show :: PutWarmPoolResponse -> String # showList :: [PutWarmPoolResponse] -> ShowS #
NFData PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods rnf :: PutWarmPoolResponse -> () #
Eq PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool Methods (==) :: PutWarmPoolResponse -> PutWarmPoolResponse -> Bool # (/=) :: PutWarmPoolResponse -> PutWarmPoolResponse -> Bool #
type Rep PutWarmPoolResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutWarmPool type Rep PutWarmPoolResponse = D1 ('MetaData "PutWarmPoolResponse" "Amazonka.AutoScaling.PutWarmPool" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "PutWarmPoolResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutWarmPoolResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutWarmPoolResponse'`
-> PutWarmPoolResponse

Create a value of PutWarmPoolResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:PutWarmPoolResponse', putWarmPoolResponse_httpStatus - The response's http status code.

Response Lenses

putWarmPoolResponse_httpStatus :: Lens' PutWarmPoolResponse Int Source #

The response's http status code.