software.amazon.awscdk.services.autoscaling

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.813Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.ILifecycleHook

ILifecycleHook.Jsii$Default, ILifecycleHook.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	LifecycleHook(software.constructs.Construct scope, String id, LifecycleHookProps props)
protected	LifecycleHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LifecycleHook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getLifecycleHookName() The name of this lifecycle hook.
IRole	getRole() The role that allows the ASG to publish to the notification target.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LifecycleHook

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

LifecycleHook

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

LifecycleHook

@Stability(value=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 Detail

getLifecycleHookName

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

The name of this lifecycle hook.

getRole

@Stability(value=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