Class LifecycleHook

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.autoscaling.LifecycleHook
All Implemented Interfaces:
IResource, ILifecycleHook, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:10.663Z") @Stability(Stable) public class LifecycleHook extends Resource implements ILifecycleHook
Define a life cycle hook.

Example:

 // 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.*;
 AutoScalingGroup autoScalingGroup;
 ILifecycleHookTarget lifecycleHookTarget;
 Role role;
 LifecycleHook lifecycleHook = LifecycleHook.Builder.create(this, "MyLifecycleHook")
         .autoScalingGroup(autoScalingGroup)
         .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();
 
  • Constructor Details

    • LifecycleHook

      protected LifecycleHook(software.amazon.jsii.JsiiObjectRef objRef)
    • LifecycleHook

      protected LifecycleHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • LifecycleHook

      @Stability(Stable) public LifecycleHook(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull LifecycleHookProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • getLifecycleHookName

      @Stability(Stable) @NotNull public String getLifecycleHookName()
      The name of this lifecycle hook.
    • getRole

      @Stability(Stable) @NotNull public IRole getRole()
      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.

      Specified by:
      getRole in interface ILifecycleHook