Stratosphere.Resources.LifecycleHook

Use AWS::AutoScaling::LifecycleHook to control the state of an instance in an Auto Scaling group after it is launched or terminated. When you use a lifecycle hook, the Auto Scaling group either pauses the instance after it is launched (before it is put into service) or pauses the instance as it is terminated (before it is fully terminated). For more information, see Examples of How to Use Lifecycle Hooks in the Auto Scaling User Guide.

Documentation

data LifecycleHook

Full data type definition for LifecycleHook. See lifecycleHook for a more convenient constructor.

Constructors

LifecycleHook

Fields

• _lifecycleHookAutoScalingGroupName :: Val Text
• _lifecycleHookDefaultResult :: Maybe (Val Text)
• _lifecycleHookHeartbeatTimeout :: Maybe (Val Integer')
• _lifecycleHookLifecycleTransition :: Val Text
• _lifecycleHookNotificationMetadata :: Maybe (Val Text)
• _lifecycleHookNotificationTargetARN :: Val Text
• _lifecycleHookRoleARN :: Val Text

Instances

Show LifecycleHook

Methods

showsPrec :: Int -> LifecycleHook -> ShowS

show :: LifecycleHook -> String

showList :: [LifecycleHook] -> ShowS

Generic LifecycleHook

Associated Types

type Rep LifecycleHook :: * -> *

Methods

from :: LifecycleHook -> Rep LifecycleHook x

to :: Rep LifecycleHook x -> LifecycleHook

ToJSON LifecycleHook

Methods

toJSON :: LifecycleHook -> Value

toEncoding :: LifecycleHook -> Encoding

toJSONList :: [LifecycleHook] -> Value

toEncodingList :: [LifecycleHook] -> Encoding

FromJSON LifecycleHook

Methods

parseJSON :: Value -> Parser LifecycleHook

parseJSONList :: Value -> Parser [LifecycleHook]

type Rep LifecycleHook

type Rep LifecycleHook = D1 (MetaData "LifecycleHook" "Stratosphere.Resources.LifecycleHook" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "LifecycleHook" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lifecycleHookAutoScalingGroupName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lifecycleHookDefaultResult") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_lifecycleHookHeartbeatTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lifecycleHookLifecycleTransition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_lifecycleHookNotificationMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_lifecycleHookNotificationTargetARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_lifecycleHookRoleARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text)))))))

lifecycleHook

Arguments

:: Val Text

lhAutoScalingGroupName

-> Val Text

lhLifecycleTransition

-> Val Text

lhNotificationTargetARN

-> Val Text

lhRoleARN

-> LifecycleHook

Constructor for LifecycleHook containing required fields as arguments.

lhAutoScalingGroupName :: Lens' LifecycleHook (Val Text)

The name of the Auto Scaling group for the lifecycle hook.

lhDefaultResult :: Lens' LifecycleHook (Maybe (Val Text))

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

lhHeartbeatTimeout :: Lens' LifecycleHook (Maybe (Val Integer'))

The amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action that you specified in the DefaultResult property.

lhLifecycleTransition :: Lens' LifecycleHook (Val Text)

The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.

lhNotificationMetadata :: Lens' LifecycleHook (Maybe (Val Text))

Additional information that you want to include when Auto Scaling sends a message to the notification target.

lhNotificationTargetARN :: Lens' LifecycleHook (Val Text)

The Amazon resource name (ARN) of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

lhRoleARN :: Lens' LifecycleHook (Val Text)

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. The role requires permissions to Amazon SNS and Amazon SQS.