Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook .

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 .

Creating a Request

recordLifecycleActionHeartbeat

Arguments

:: Text

rlahLifecycleHookName

-> Text

rlahAutoScalingGroupName

-> RecordLifecycleActionHeartbeat

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

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

• rlahInstanceId - The ID of the instance.
• rlahLifecycleActionToken - A token that uniquely 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.
• rlahLifecycleHookName - The name of the lifecycle hook.
• rlahAutoScalingGroupName - The name of the Auto Scaling group.

data RecordLifecycleActionHeartbeat

See: recordLifecycleActionHeartbeat smart constructor.

Instances

Eq RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

(==) :: RecordLifecycleActionHeartbeat -> RecordLifecycleActionHeartbeat -> Bool

(/=) :: RecordLifecycleActionHeartbeat -> RecordLifecycleActionHeartbeat -> Bool

Data RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

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

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

toConstr :: RecordLifecycleActionHeartbeat -> Constr

dataTypeOf :: RecordLifecycleActionHeartbeat -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> RecordLifecycleActionHeartbeat -> RecordLifecycleActionHeartbeat

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

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

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

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

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

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

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

Read RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

readsPrec :: Int -> ReadS RecordLifecycleActionHeartbeat

readList :: ReadS [RecordLifecycleActionHeartbeat]

readPrec :: ReadPrec RecordLifecycleActionHeartbeat

readListPrec :: ReadPrec [RecordLifecycleActionHeartbeat]

Show RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

showsPrec :: Int -> RecordLifecycleActionHeartbeat -> ShowS

show :: RecordLifecycleActionHeartbeat -> String

showList :: [RecordLifecycleActionHeartbeat] -> ShowS

Generic RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Associated Types

type Rep RecordLifecycleActionHeartbeat :: Type -> Type

Methods

from :: RecordLifecycleActionHeartbeat -> Rep RecordLifecycleActionHeartbeat x

to :: Rep RecordLifecycleActionHeartbeat x -> RecordLifecycleActionHeartbeat

Hashable RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

hashWithSalt :: Int -> RecordLifecycleActionHeartbeat -> Int

hash :: RecordLifecycleActionHeartbeat -> Int

AWSRequest RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Associated Types

type Rs RecordLifecycleActionHeartbeat :: Type

Methods

request :: RecordLifecycleActionHeartbeat -> Request RecordLifecycleActionHeartbeat

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy RecordLifecycleActionHeartbeat -> ClientResponse -> m (Response RecordLifecycleActionHeartbeat)

ToHeaders RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

toHeaders :: RecordLifecycleActionHeartbeat -> [Header]

ToPath RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

toPath :: RecordLifecycleActionHeartbeat -> ByteString

ToQuery RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

toQuery :: RecordLifecycleActionHeartbeat -> QueryString

NFData RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

rnf :: RecordLifecycleActionHeartbeat -> ()

type Rep RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

type Rep RecordLifecycleActionHeartbeat = D1 (MetaData "RecordLifecycleActionHeartbeat" "Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat" "amazonka-autoscaling-1.6.1-AbdWdH026wCXAk2CK79vG" False) (C1 (MetaCons "RecordLifecycleActionHeartbeat'" PrefixI True) ((S1 (MetaSel (Just "_rlahInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rlahLifecycleActionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rlahLifecycleHookName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rlahAutoScalingGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs RecordLifecycleActionHeartbeat

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

type Rs RecordLifecycleActionHeartbeat = RecordLifecycleActionHeartbeatResponse

Request Lenses

rlahInstanceId :: Lens' RecordLifecycleActionHeartbeat (Maybe Text)

The ID of the instance.

rlahLifecycleActionToken :: Lens' RecordLifecycleActionHeartbeat (Maybe Text)

A token that uniquely 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.

rlahLifecycleHookName :: Lens' RecordLifecycleActionHeartbeat Text

The name of the lifecycle hook.

rlahAutoScalingGroupName :: Lens' RecordLifecycleActionHeartbeat Text

The name of the Auto Scaling group.

Destructuring the Response

recordLifecycleActionHeartbeatResponse

Arguments

:: Int

rlahrsResponseStatus

-> RecordLifecycleActionHeartbeatResponse

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

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

• rlahrsResponseStatus - -- | The response status code.

data RecordLifecycleActionHeartbeatResponse

See: recordLifecycleActionHeartbeatResponse smart constructor.

Instances

Eq RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

(==) :: RecordLifecycleActionHeartbeatResponse -> RecordLifecycleActionHeartbeatResponse -> Bool

(/=) :: RecordLifecycleActionHeartbeatResponse -> RecordLifecycleActionHeartbeatResponse -> Bool

Data RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

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

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

toConstr :: RecordLifecycleActionHeartbeatResponse -> Constr

dataTypeOf :: RecordLifecycleActionHeartbeatResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> RecordLifecycleActionHeartbeatResponse -> RecordLifecycleActionHeartbeatResponse

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

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

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

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

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

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

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

Read RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

readsPrec :: Int -> ReadS RecordLifecycleActionHeartbeatResponse

readList :: ReadS [RecordLifecycleActionHeartbeatResponse]

readPrec :: ReadPrec RecordLifecycleActionHeartbeatResponse

readListPrec :: ReadPrec [RecordLifecycleActionHeartbeatResponse]

Show RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

showsPrec :: Int -> RecordLifecycleActionHeartbeatResponse -> ShowS

show :: RecordLifecycleActionHeartbeatResponse -> String

showList :: [RecordLifecycleActionHeartbeatResponse] -> ShowS

Generic RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Associated Types

type Rep RecordLifecycleActionHeartbeatResponse :: Type -> Type

Methods

from :: RecordLifecycleActionHeartbeatResponse -> Rep RecordLifecycleActionHeartbeatResponse x

to :: Rep RecordLifecycleActionHeartbeatResponse x -> RecordLifecycleActionHeartbeatResponse

NFData RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

Methods

rnf :: RecordLifecycleActionHeartbeatResponse -> ()

type Rep RecordLifecycleActionHeartbeatResponse

Defined in Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat

type Rep RecordLifecycleActionHeartbeatResponse = D1 (MetaData "RecordLifecycleActionHeartbeatResponse" "Network.AWS.AutoScaling.RecordLifecycleActionHeartbeat" "amazonka-autoscaling-1.6.1-AbdWdH026wCXAk2CK79vG" True) (C1 (MetaCons "RecordLifecycleActionHeartbeatResponse'" PrefixI True) (S1 (MetaSel (Just "_rlahrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

rlahrsResponseStatus :: Lens' RecordLifecycleActionHeartbeatResponse Int

• - | The response status code.