LifecycleHookProps¶
-
class
aws_cdk.aws_autoscaling.LifecycleHookProps(*, lifecycle_transition, notification_target, default_result=None, heartbeat_timeout=None, lifecycle_hook_name=None, notification_metadata=None, role=None, auto_scaling_group)¶ Bases:
aws_cdk.aws_autoscaling.BasicLifecycleHookProps-
__init__(*, lifecycle_transition, notification_target, default_result=None, heartbeat_timeout=None, lifecycle_hook_name=None, notification_metadata=None, role=None, auto_scaling_group)¶ Properties for a Lifecycle hook.
- Parameters
lifecycle_transition (
LifecycleTransition) – The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.notification_target (
ILifecycleHookTarget) – The target of the lifecycle hook.default_result (
Optional[DefaultResult]) – The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. Default: Continueheartbeat_timeout (
Optional[Duration]) – Maximum time between calls to RecordLifecycleActionHeartbeat for the hook. If the lifecycle hook times out, perform the action in DefaultResult. Default: - No heartbeat timeout.lifecycle_hook_name (
Optional[str]) – Name of the lifecycle hook. Default: - Automatically generated name.notification_metadata (
Optional[str]) – Additional data to pass to the lifecycle hook target. Default: - No metadata.role (
Optional[IRole]) – The role that allows publishing to the notification target. Default: - A role is automatically created.auto_scaling_group (
IAutoScalingGroup) – The AutoScalingGroup to add the lifecycle hook to.
Attributes
-
auto_scaling_group¶ The AutoScalingGroup to add the lifecycle hook to.
- Return type
-
default_result¶ The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
default :default: Continue
- Return type
Optional[DefaultResult]
-
heartbeat_timeout¶ Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.
If the lifecycle hook times out, perform the action in DefaultResult.
default :default: - No heartbeat timeout.
- Return type
Optional[Duration]
-
lifecycle_hook_name¶ Name of the lifecycle hook.
default :default: - Automatically generated name.
- Return type
Optional[str]
-
lifecycle_transition¶ The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.
- Return type
-
notification_metadata¶ Additional data to pass to the lifecycle hook target.
default :default: - No metadata.
- Return type
Optional[str]
-
notification_target¶ The target of the lifecycle hook.
- Return type
-