LifecycleHook¶
-
class
aws_cdk.aws_autoscaling.
LifecycleHook
(scope, id, *, auto_scaling_group, lifecycle_transition, notification_target, default_result=None, heartbeat_timeout=None, lifecycle_hook_name=None, notification_metadata=None, role=None)¶ Bases:
aws_cdk.core.Resource
Define a life cycle hook.
- 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.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.
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.DELETE
), 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.
- Return type
-
lifecycle_hook_name
¶ The name of this lifecycle hook.
- Attribute
true
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
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