class Aws::AutoScaling::Types::PutLifecycleHookType
@note When making an API call, you may pass PutLifecycleHookType
data as a hash: { lifecycle_hook_name: "AsciiStringMaxLen255", # required auto_scaling_group_name: "XmlStringMaxLen255", # required lifecycle_transition: "LifecycleTransition", role_arn: "XmlStringMaxLen255", notification_target_arn: "NotificationTargetResourceName", notification_metadata: "XmlStringMaxLen1023", heartbeat_timeout: 1, default_result: "LifecycleActionResult", }
@!attribute [rw] lifecycle_hook_name
The name of the lifecycle hook. @return [String]
@!attribute [rw] auto_scaling_group_name
The name of the Auto Scaling group. @return [String]
@!attribute [rw] lifecycle_transition
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. @return [String]
@!attribute [rw] role_arn
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. @return [String]
@!attribute [rw] notification_target_arn
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"`. @return [String]
@!attribute [rw] notification_metadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. @return [String]
@!attribute [rw] heartbeat_timeout
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. @return [Integer]
@!attribute [rw] default_result
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`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutLifecycleHookType AWS API Documentation
Constants
- SENSITIVE