Skip to content

LifecycleHook

Source code in docs_src/capo_auto_scaling/types/lifecycle_hook.py
class LifecycleHook(TypedDict, closed=True):
    lifecycle_hook_name: NotRequired[
        "capo_auto_scaling.types.ascii_string_max_len255.AsciiStringMaxLen255"
    ]
    """<p>The name of the lifecycle hook.</p>"""
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group for the lifecycle hook.</p>"""
    lifecycle_transition: NotRequired[
        "capo_auto_scaling.types.lifecycle_transition.LifecycleTransition"
    ]
    """<p>The lifecycle transition.</p> <p>Valid values: <code>autoscaling:EC2_INSTANCE_LAUNCHING</code> | <code>autoscaling:EC2_INSTANCE_TERMINATING</code> </p>"""
    notification_target_arn: NotRequired[
        "capo_auto_scaling.types.notification_target_resource_name.NotificationTargetResourceName"
    ]
    """<p>The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.</p>"""
    role_arn: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).</p>"""
    notification_metadata: NotRequired[
        "capo_auto_scaling.types.any_printable_ascii_string_max_len4000.AnyPrintableAsciiStringMaxLen4000"
    ]
    """<p>Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.</p>"""
    heartbeat_timeout: NotRequired[
        "capo_auto_scaling.types.heartbeat_timeout.HeartbeatTimeout"
    ]
    """<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the <code>DefaultResult</code> property.</p>"""
    global_timeout: NotRequired["capo_auto_scaling.types.global_timeout.GlobalTimeout"]
    """<p>The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times <code>HeartbeatTimeout</code>, whichever is smaller.</p>"""
    default_result: NotRequired[
        "capo_auto_scaling.types.lifecycle_action_result.LifecycleActionResult"
    ]
    """<p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.</p> <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code> </p>"""

auto_scaling_group_name instance-attribute

auto_scaling_group_name: NotRequired[XmlStringMaxLen255]

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

default_result instance-attribute

default_result: NotRequired[LifecycleActionResult]

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

Valid values: CONTINUE | ABANDON

global_timeout instance-attribute

global_timeout: NotRequired[GlobalTimeout]

The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

heartbeat_timeout instance-attribute

heartbeat_timeout: NotRequired[HeartbeatTimeout]

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

lifecycle_hook_name instance-attribute

lifecycle_hook_name: NotRequired[AsciiStringMaxLen255]

The name of the lifecycle hook.

lifecycle_transition instance-attribute

lifecycle_transition: NotRequired[LifecycleTransition]

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

notification_metadata instance-attribute

notification_metadata: NotRequired[AnyPrintableAsciiStringMaxLen4000]

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

notification_target_arn instance-attribute

notification_target_arn: NotRequired[NotificationTargetResourceName]

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

role_arn instance-attribute

role_arn: NotRequired[XmlStringMaxLen255]

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).