LifecycleHook

class aws_cdk.aws_autoscaling.LifecycleHook(scope, id, *, auto_scaling_group, lifecycle_transition, default_result=None, heartbeat_timeout=None, lifecycle_hook_name=None, notification_metadata=None, notification_target=None, role=None)

Bases: Resource

Define a life cycle hook.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_autoscaling as autoscaling
import aws_cdk.aws_iam as iam
import aws_cdk.core as cdk

# auto_scaling_group: autoscaling.AutoScalingGroup
# lifecycle_hook_target: autoscaling.ILifecycleHookTarget
# role: iam.Role

lifecycle_hook = autoscaling.LifecycleHook(self, "MyLifecycleHook",
    auto_scaling_group=auto_scaling_group,
    lifecycle_transition=autoscaling.LifecycleTransition.INSTANCE_LAUNCHING,

    # the properties below are optional
    default_result=autoscaling.DefaultResult.CONTINUE,
    heartbeat_timeout=cdk.Duration.minutes(30),
    lifecycle_hook_name="lifecycleHookName",
    notification_metadata="notificationMetadata",
    notification_target=lifecycle_hook_target,
    role=role
)

Parameters:

scope (Construct) –
id (str) –
auto_scaling_group (IAutoScalingGroup) – The AutoScalingGroup to add the lifecycle hook to.
lifecycle_transition (LifecycleTransition) – The state of the Amazon EC2 instance to which you want to attach 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: Continue
heartbeat_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.
notification_target (Optional[ILifecycleHookTarget]) – The target of the lifecycle hook. Default: - No target.
role (Optional[IRole]) – The role that allows publishing to the notification target. Default: - A role will be created if a target is provided. Otherwise, no role is created.

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

lifecycle_hook_name

The name of this lifecycle hook.

Attribute:: true

node: The construct tree node associated with this construct.

role

The role that allows the ASG to publish to the notification target.

Default:

A default role is created if ‘notificationTarget’ is specified.

Otherwise, no role is created.

stack: The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool