LifecycleHook L2 construct
Define a life cycle hook.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_autoscaling as interfaces_autoscaling } from 'aws-cdk-lib/interfaces';
declare const autoScalingGroupRef: interfaces_autoscaling.IAutoScalingGroupRef;
declare const lifecycleHookTarget: autoscaling.ILifecycleHookTarget;
declare const role: iam.Role;
const lifecycleHook = new autoscaling.LifecycleHook(this, 'MyLifecycleHook', {
autoScalingGroup: autoScalingGroupRef,
lifecycleTransition: autoscaling.LifecycleTransition.INSTANCE_LAUNCHING,
// the properties below are optional
defaultResult: autoscaling.DefaultResult.CONTINUE,
heartbeatTimeout: cdk.Duration.minutes(30),
lifecycleHookName: 'lifecycleHookName',
notificationMetadata: 'notificationMetadata',
notificationTarget: lifecycleHookTarget,
role: role,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_autoscaling as autoscaling
from aws_cdk import aws_iam as iam
from aws_cdk.interfaces import aws_autoscaling as interfaces_autoscaling
# auto_scaling_group_ref: interfaces_autoscaling.IAutoScalingGroupRef
# lifecycle_hook_target: autoscaling.ILifecycleHookTarget
# role: iam.Role
lifecycle_hook = autoscaling.LifecycleHook(self, "MyLifecycleHook",
auto_scaling_group=auto_scaling_group_ref,
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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.autoscaling.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.interfaces.autoscaling.*;
IAutoScalingGroupRef autoScalingGroupRef;
ILifecycleHookTarget lifecycleHookTarget;
Role role;
LifecycleHook lifecycleHook = LifecycleHook.Builder.create(this, "MyLifecycleHook")
.autoScalingGroup(autoScalingGroupRef)
.lifecycleTransition(LifecycleTransition.INSTANCE_LAUNCHING)
// the properties below are optional
.defaultResult(DefaultResult.CONTINUE)
.heartbeatTimeout(Duration.minutes(30))
.lifecycleHookName("lifecycleHookName")
.notificationMetadata("notificationMetadata")
.notificationTarget(lifecycleHookTarget)
.role(role)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.AutoScaling;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.AutoScaling;
IAutoScalingGroupRef autoScalingGroupRef;
ILifecycleHookTarget lifecycleHookTarget;
Role role;
var lifecycleHook = new LifecycleHook(this, "MyLifecycleHook", new LifecycleHookProps {
AutoScalingGroup = autoScalingGroupRef,
LifecycleTransition = LifecycleTransition.INSTANCE_LAUNCHING,
// the properties below are optional
DefaultResult = DefaultResult.CONTINUE,
HeartbeatTimeout = Duration.Minutes(30),
LifecycleHookName = "lifecycleHookName",
NotificationMetadata = "notificationMetadata",
NotificationTarget = lifecycleHookTarget,
Role = role
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var autoScalingGroupRef IAutoScalingGroupRef
var lifecycleHookTarget ILifecycleHookTarget
var role Role
lifecycleHook := awscdk.Aws_autoscaling.NewLifecycleHook(this, jsii.String("MyLifecycleHook"), &LifecycleHookProps{
AutoScalingGroup: autoScalingGroupRef,
LifecycleTransition: awscdk.*Aws_autoscaling.LifecycleTransition_INSTANCE_LAUNCHING,
// the properties below are optional
DefaultResult: awscdk.*Aws_autoscaling.DefaultResult_CONTINUE,
HeartbeatTimeout: cdk.Duration_Minutes(jsii.Number(30)),
LifecycleHookName: jsii.String("lifecycleHookName"),
NotificationMetadata: jsii.String("notificationMetadata"),
NotificationTarget: lifecycleHookTarget,
Role: role,
})
Initializer
ts
new LifecycleHook(scope: Construct, id: string, props: LifecycleHookProps)
python
LifecycleHook(scope: Construct, id: str, props: LifecycleHookProps)
java
new LifecycleHook(Construct scope, String id, LifecycleHookProps props)
csharp
new LifecycleHook(Construct scope, string id, LifecycleHookProps props)
go
NewLifecycleHook(Scope Construct, Id *string, Props LifecycleHookProps)
Construct Props
autoScalingGroupIAutoScalingGroupRefauto_scaling_groupIAutoScalingGroupRefautoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefrequired#The AutoScalingGroup to add the lifecycle hook to.
defaultResultDefaultResultdefault_resultDefaultResultdefaultResultDefaultResultDefaultResultDefaultResultDefaultResultDefaultResult= Continue#The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
heartbeatTimeoutDurationheartbeat_timeoutDurationheartbeatTimeoutDurationHeartbeatTimeoutDurationHeartbeatTimeoutDuration= No heartbeat timeout.#Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.
If the lifecycle hook times out, perform the action in DefaultResult.
lifecycleHookNamestringlifecycle_hook_namestrlifecycleHookNameStringLifecycleHookNamestringLifecycleHookName*string= Automatically generated name.#Name of the lifecycle hook.
lifecycleTransitionLifecycleTransitionlifecycle_transitionLifecycleTransitionlifecycleTransitionLifecycleTransitionLifecycleTransitionLifecycleTransitionLifecycleTransitionLifecycleTransitionrequired#The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.
notificationMetadatastringnotification_metadatastrnotificationMetadataStringNotificationMetadatastringNotificationMetadata*string= No metadata.#Additional data to pass to the lifecycle hook target.
notificationTargetILifecycleHookTargetnotification_targetILifecycleHookTargetnotificationTargetILifecycleHookTargetNotificationTargetILifecycleHookTargetNotificationTargetILifecycleHookTarget= No target.#The target of the lifecycle hook.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
lifecycleHookNamestringlifecycle_hook_namestrlifecycleHookNameStringLifecycleHookNamestringLifecycleHookName*stringrequired#The name of this lifecycle hook.
lifecycleHookRefLifecycleHookReferencelifecycle_hook_refLifecycleHookReferencelifecycleHookRefLifecycleHookReferenceLifecycleHookRefLifecycleHookReferenceLifecycleHookRefLifecycleHookReferencerequired#A reference to a LifecycleHook resource.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
The role that allows the ASG to publish to the notification target.
default
Default: A default role is created if 'notificationTarget' is specified. Otherwise, no role is created.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.