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.PutLifecycleHook

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates or updates a lifecycle hook for the specified Auto Scaling group.

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

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

(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(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 Amazon EC2 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 wait state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

Synopsis

data PutLifecycleHook = PutLifecycleHook' {
- defaultResult :: Maybe Text
- heartbeatTimeout :: Maybe Int
- lifecycleTransition :: Maybe Text
- notificationMetadata :: Maybe Text
- notificationTargetARN :: Maybe Text
- roleARN :: Maybe Text
- lifecycleHookName :: Text
- autoScalingGroupName :: Text
}
newPutLifecycleHook :: Text -> Text -> PutLifecycleHook
putLifecycleHook_defaultResult :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_heartbeatTimeout :: Lens' PutLifecycleHook (Maybe Int)
putLifecycleHook_lifecycleTransition :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_notificationMetadata :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_notificationTargetARN :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_roleARN :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_lifecycleHookName :: Lens' PutLifecycleHook Text
putLifecycleHook_autoScalingGroupName :: Lens' PutLifecycleHook Text
data PutLifecycleHookResponse = PutLifecycleHookResponse' {
- httpStatus :: Int
}
newPutLifecycleHookResponse :: Int -> PutLifecycleHookResponse
putLifecycleHookResponse_httpStatus :: Lens' PutLifecycleHookResponse Int

Creating a Request

data PutLifecycleHook Source #

See: newPutLifecycleHook smart constructor.

Constructors

PutLifecycleHook'

Fields

defaultResult :: Maybe Text
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON
heartbeatTimeout :: Maybe Int
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).
lifecycleTransition :: Maybe Text
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
- To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
Required for new lifecycle hooks, but optional when updating existing hooks.
notificationMetadata :: Maybe Text
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
notificationTargetARN :: Maybe Text
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
roleARN :: Maybe Text
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
lifecycleHookName :: Text
The name of the lifecycle hook.
autoScalingGroupName :: Text
The name of the Auto Scaling group.

Instances

Instances details

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

newPutLifecycleHook Source #

Arguments

:: Text	`PutLifecycleHook`
-> Text	`PutLifecycleHook`
-> PutLifecycleHook

Create a value of PutLifecycleHook 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:

PutLifecycleHook, putLifecycleHook_defaultResult - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.

Valid values: CONTINUE | ABANDON

PutLifecycleHook, putLifecycleHook_heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

PutLifecycleHook, putLifecycleHook_lifecycleTransition - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

Required for new lifecycle hooks, but optional when updating existing hooks.

PutLifecycleHook, putLifecycleHook_notificationMetadata - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

PutLifecycleHook, putLifecycleHook_notificationTargetARN - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

PutLifecycleHook, putLifecycleHook_roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

PutLifecycleHook, putLifecycleHook_lifecycleHookName - The name of the lifecycle hook.

PutLifecycleHook, putLifecycleHook_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

putLifecycleHook_defaultResult :: Lens' PutLifecycleHook (Maybe Text) Source #

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

Valid values: CONTINUE | ABANDON

putLifecycleHook_heartbeatTimeout :: Lens' PutLifecycleHook (Maybe Int) Source #

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

putLifecycleHook_lifecycleTransition :: Lens' PutLifecycleHook (Maybe Text) Source #

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

Required for new lifecycle hooks, but optional when updating existing hooks.

putLifecycleHook_notificationMetadata :: Lens' PutLifecycleHook (Maybe Text) Source #

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

putLifecycleHook_notificationTargetARN :: Lens' PutLifecycleHook (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

putLifecycleHook_roleARN :: Lens' PutLifecycleHook (Maybe Text) Source #

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

putLifecycleHook_lifecycleHookName :: Lens' PutLifecycleHook Text Source #

The name of the lifecycle hook.

putLifecycleHook_autoScalingGroupName :: Lens' PutLifecycleHook Text Source #

The name of the Auto Scaling group.

Destructuring the Response

data PutLifecycleHookResponse Source #

See: newPutLifecycleHookResponse smart constructor.

Constructors

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

Instances

Instances details

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

newPutLifecycleHookResponse Source #

Arguments

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

Create a value of PutLifecycleHookResponse 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:PutLifecycleHookResponse', putLifecycleHookResponse_httpStatus - The response's http status code.

Response Lenses

putLifecycleHookResponse_httpStatus :: Lens' PutLifecycleHookResponse Int Source #

The response's http status code.