Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

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 Amazon EC2 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 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 pending state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, complete the lifecycle action 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
- notificationMetadata :: Maybe Text
- notificationTargetARN :: Maybe Text
- lifecycleTransition :: 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_notificationMetadata :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_notificationTargetARN :: Lens' PutLifecycleHook (Maybe Text)
putLifecycleHook_lifecycleTransition :: 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
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is 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).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.
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 ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
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".
lifecycleTransition :: Maybe Text
The instance state to which you want to attach the lifecycle hook. The valid values are:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
Required for new lifecycle hooks, but optional when updating existing hooks.
roleARN :: Maybe Text
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, 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

Eq PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Methods (==) :: PutLifecycleHook -> PutLifecycleHook -> Bool # (/=) :: PutLifecycleHook -> PutLifecycleHook -> Bool #
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 #
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 #
NFData PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Methods rnf :: PutLifecycleHook -> () #
Hashable PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Methods hashWithSalt :: Int -> PutLifecycleHook -> Int # hash :: PutLifecycleHook -> Int #
AWSRequest PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Associated Types type AWSResponse PutLifecycleHook # Methods request :: PutLifecycleHook -> Request PutLifecycleHook # response :: MonadResource m => Logger -> Service -> Proxy PutLifecycleHook -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutLifecycleHook))) #
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 #
type Rep PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook type Rep PutLifecycleHook = D1 ('MetaData "PutLifecycleHook" "Amazonka.AutoScaling.PutLifecycleHook" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" '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 "notificationMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notificationTargetARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "lifecycleTransition") '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)))))
type AWSResponse PutLifecycleHook Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook type AWSResponse PutLifecycleHook = PutLifecycleHookResponse

newPutLifecycleHook Source #

Arguments

:: Text	`$sel:lifecycleHookName:PutLifecycleHook'`
-> Text	`$sel:autoScalingGroupName: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:

$sel:defaultResult:PutLifecycleHook', putLifecycleHook_defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

$sel:heartbeatTimeout: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).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

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

$sel:notificationTargetARN:PutLifecycleHook', putLifecycleHook_notificationTargetARN - The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

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

$sel:lifecycleTransition:PutLifecycleHook', putLifecycleHook_lifecycleTransition - The instance state to which you want to attach the lifecycle hook. The valid values are:

autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING

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

$sel:roleARN:PutLifecycleHook', putLifecycleHook_roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

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

$sel:lifecycleHookName:PutLifecycleHook', putLifecycleHook_lifecycleHookName - The name of the lifecycle hook.

$sel:autoScalingGroupName:PutLifecycleHook', putLifecycleHook_autoScalingGroupName - The name of the Auto Scaling group.

Request Lenses

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

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is 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).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.

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 ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

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_lifecycleTransition :: Lens' PutLifecycleHook (Maybe Text) Source #

The instance state to which you want to attach the lifecycle hook. The valid values are:

autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING

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

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, for example, 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

Eq PutLifecycleHookResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Methods (==) :: PutLifecycleHookResponse -> PutLifecycleHookResponse -> Bool # (/=) :: PutLifecycleHookResponse -> PutLifecycleHookResponse -> Bool #
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 #
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 #
NFData PutLifecycleHookResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook Methods rnf :: PutLifecycleHookResponse -> () #
type Rep PutLifecycleHookResponse Source #
Instance details Defined in Amazonka.AutoScaling.PutLifecycleHook type Rep PutLifecycleHookResponse = D1 ('MetaData "PutLifecycleHookResponse" "Amazonka.AutoScaling.PutLifecycleHook" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" '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.