amazonka-autoscaling-1.6.0: Amazon Auto Scaling SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.AutoScaling.CompleteLifecycleAction

Contents

Description

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  • (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.
  • (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.
  • Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
  • If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
  • If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide .

Synopsis

Creating a Request

completeLifecycleAction #

Creates a value of CompleteLifecycleAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CompleteLifecycleAction #

See: completeLifecycleAction smart constructor.

Instances
Eq CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Data CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompleteLifecycleAction -> c CompleteLifecycleAction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompleteLifecycleAction #

toConstr :: CompleteLifecycleAction -> Constr #

dataTypeOf :: CompleteLifecycleAction -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompleteLifecycleAction) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompleteLifecycleAction) #

gmapT :: (forall b. Data b => b -> b) -> CompleteLifecycleAction -> CompleteLifecycleAction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompleteLifecycleAction -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompleteLifecycleAction -> r #

gmapQ :: (forall d. Data d => d -> u) -> CompleteLifecycleAction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompleteLifecycleAction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompleteLifecycleAction -> m CompleteLifecycleAction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompleteLifecycleAction -> m CompleteLifecycleAction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompleteLifecycleAction -> m CompleteLifecycleAction #

Read CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Show CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Generic CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Associated Types

type Rep CompleteLifecycleAction :: * -> * #

Hashable CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

AWSRequest CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Associated Types

type Rs CompleteLifecycleAction :: * #

ToHeaders CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

ToPath CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

ToQuery CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

NFData CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Methods

rnf :: CompleteLifecycleAction -> () #

type Rep CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

type Rep CompleteLifecycleAction = D1 (MetaData "CompleteLifecycleAction" "Network.AWS.AutoScaling.CompleteLifecycleAction" "amazonka-autoscaling-1.6.0-DYtPJWRFp2RHFedRQEOKCy" False) (C1 (MetaCons "CompleteLifecycleAction'" PrefixI True) ((S1 (MetaSel (Just "_claInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_claLifecycleActionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_claLifecycleHookName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_claAutoScalingGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_claLifecycleActionResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CompleteLifecycleAction # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Request Lenses

claLifecycleActionToken :: Lens' CompleteLifecycleAction (Maybe Text) #

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

claLifecycleHookName :: Lens' CompleteLifecycleAction Text #

The name of the lifecycle hook.

claAutoScalingGroupName :: Lens' CompleteLifecycleAction Text #

The name of the Auto Scaling group.

claLifecycleActionResult :: Lens' CompleteLifecycleAction Text #

The action for the group to take. This parameter can be either CONTINUE or ABANDON .

Destructuring the Response

completeLifecycleActionResponse #

Creates a value of CompleteLifecycleActionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CompleteLifecycleActionResponse #

See: completeLifecycleActionResponse smart constructor.

Instances
Eq CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Data CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompleteLifecycleActionResponse -> c CompleteLifecycleActionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompleteLifecycleActionResponse #

toConstr :: CompleteLifecycleActionResponse -> Constr #

dataTypeOf :: CompleteLifecycleActionResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompleteLifecycleActionResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompleteLifecycleActionResponse) #

gmapT :: (forall b. Data b => b -> b) -> CompleteLifecycleActionResponse -> CompleteLifecycleActionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompleteLifecycleActionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompleteLifecycleActionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CompleteLifecycleActionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompleteLifecycleActionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompleteLifecycleActionResponse -> m CompleteLifecycleActionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompleteLifecycleActionResponse -> m CompleteLifecycleActionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompleteLifecycleActionResponse -> m CompleteLifecycleActionResponse #

Read CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Show CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Generic CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

Associated Types

type Rep CompleteLifecycleActionResponse :: * -> * #

NFData CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

type Rep CompleteLifecycleActionResponse # 
Instance details

Defined in Network.AWS.AutoScaling.CompleteLifecycleAction

type Rep CompleteLifecycleActionResponse = D1 (MetaData "CompleteLifecycleActionResponse" "Network.AWS.AutoScaling.CompleteLifecycleAction" "amazonka-autoscaling-1.6.0-DYtPJWRFp2RHFedRQEOKCy" True) (C1 (MetaCons "CompleteLifecycleActionResponse'" PrefixI True) (S1 (MetaSel (Just "_clarsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses