software.amazon.awscdk.services.autoscaling

Class CfnLifecycleHook

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.autoscaling.CfnLifecycleHook

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.774Z")
 @Stability(value=Stable)
public class CfnLifecycleHook
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AutoScaling::LifecycleHook`.

The AWS::AutoScaling::LifecycleHook resource specifies lifecycle hooks for an Auto Scaling group. These hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. A lifecycle hook provides a specified amount of time (one hour by default) to wait for the action to complete before the instance transitions to the next state.

Use lifecycle hooks to prepare new instances for use or to delay them from being registered behind a load balancer before their configuration has been applied completely. You can also use lifecycle hooks to prepare running instances to be terminated by, for example, downloading logs or other data.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 CfnLifecycleHook cfnLifecycleHook = CfnLifecycleHook.Builder.create(this, "MyCfnLifecycleHook")
         .autoScalingGroupName("autoScalingGroupName")
         .lifecycleTransition("lifecycleTransition")
         // the properties below are optional
         .defaultResult("defaultResult")
         .heartbeatTimeout(123)
         .lifecycleHookName("lifecycleHookName")
         .notificationMetadata("notificationMetadata")
         .notificationTargetArn("notificationTargetArn")
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLifecycleHook.Builder A fluent builder for CfnLifecycleHook.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLifecycleHook(software.constructs.Construct scope, String id, CfnLifecycleHookProps props) Create a new `AWS::AutoScaling::LifecycleHook`.
protected	CfnLifecycleHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLifecycleHook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAutoScalingGroupName() The name of the Auto Scaling group.
protected Map<String,Object>	getCfnProperties()
String	getDefaultResult() The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
Number	getHeartbeatTimeout() The maximum time, in seconds, that can elapse before the lifecycle hook times out.
String	getLifecycleHookName() The name of the lifecycle hook.
String	getLifecycleTransition() The lifecycle transition.
String	getNotificationMetadata() Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
String	getNotificationTargetArn() The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
String	getRoleArn() The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoScalingGroupName(String value) The name of the Auto Scaling group.
void	setDefaultResult(String value) The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
void	setHeartbeatTimeout(Number value) The maximum time, in seconds, that can elapse before the lifecycle hook times out.
void	setLifecycleHookName(String value) The name of the lifecycle hook.
void	setLifecycleTransition(String value) The lifecycle transition.
void	setNotificationMetadata(String value) Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
void	setNotificationTargetArn(String value) The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
void	setRoleArn(String value) The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLifecycleHook

protected CfnLifecycleHook(software.amazon.jsii.JsiiObjectRef objRef)

CfnLifecycleHook

protected CfnLifecycleHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLifecycleHook

@Stability(value=Stable)
public CfnLifecycleHook(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnLifecycleHookProps props)

Create a new `AWS::AutoScaling::LifecycleHook`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAutoScalingGroupName

@Stability(value=Stable)
 @NotNull
public String getAutoScalingGroupName()

The name of the Auto Scaling group.

setAutoScalingGroupName

@Stability(value=Stable)
public void setAutoScalingGroupName(@NotNull
                                                             String value)

The name of the Auto Scaling group.

getLifecycleTransition

@Stability(value=Stable)
 @NotNull
public String getLifecycleTransition()

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

• To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING .
• To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING .

setLifecycleTransition

@Stability(value=Stable)
public void setLifecycleTransition(@NotNull
                                                            String value)

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

• To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING .
• To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING .

getDefaultResult

@Stability(value=Stable)
 @Nullable
public String getDefaultResult()

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

The default value is ABANDON .

Valid values: CONTINUE | ABANDON

setDefaultResult

@Stability(value=Stable)
public void setDefaultResult(@Nullable
                                                      String value)

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

The default value is ABANDON .

Valid values: CONTINUE | ABANDON

getHeartbeatTimeout

@Stability(value=Stable)
 @Nullable
public Number getHeartbeatTimeout()

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

setHeartbeatTimeout

@Stability(value=Stable)
public void setHeartbeatTimeout(@Nullable
                                                         Number value)

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

getLifecycleHookName

@Stability(value=Stable)
 @Nullable
public String getLifecycleHookName()

The name of the lifecycle hook.

setLifecycleHookName

@Stability(value=Stable)
public void setLifecycleHookName(@Nullable
                                                          String value)

The name of the lifecycle hook.

getNotificationMetadata

@Stability(value=Stable)
 @Nullable
public String getNotificationMetadata()

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

setNotificationMetadata

@Stability(value=Stable)
public void setNotificationMetadata(@Nullable
                                                             String value)

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

getNotificationTargetArn

@Stability(value=Stable)
 @Nullable
public String getNotificationTargetArn()

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

You can specify an Amazon SNS topic or an Amazon SQS queue.

setNotificationTargetArn

@Stability(value=Stable)
public void setNotificationTargetArn(@Nullable
                                                              String value)

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

You can specify an Amazon SNS topic or an Amazon SQS queue.

getRoleArn

@Stability(value=Stable)
 @Nullable
public String getRoleArn()

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide .

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide .

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.