Package software.amazon.awscdk.services.autoscaling

Class CfnLifecycleHook

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.autoscaling.CfnLifecycleHook
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.290Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLifecycleHook

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

    • CfnLifecycleHook

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

    • CfnLifecycleHook

      @Stability(Stable) public CfnLifecycleHook(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAutoScalingGroupName

      @Stability(Stable) @NotNull public String getAutoScalingGroupName()
      The name of the Auto Scaling group.

    • setAutoScalingGroupName

      @Stability(Stable) public void setAutoScalingGroupName(@NotNull String value)
      The name of the Auto Scaling group.

    • getLifecycleTransition

      @Stability(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(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(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(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(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(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(Stable) @Nullable public String getLifecycleHookName()
      The name of the lifecycle hook.

    • setLifecycleHookName

      @Stability(Stable) public void setLifecycleHookName(@Nullable String value)
      The name of the lifecycle hook.

    • getNotificationMetadata

      @Stability(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(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(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(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(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(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.