software.amazon.awscdk.services.autoscaling

Interface LifecycleHookProps

All Superinterfaces:

BasicLifecycleHookProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LifecycleHookProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:01.363Z")
 @Stability(value=Experimental)
public interface LifecycleHookProps
extends software.amazon.jsii.JsiiSerializable, BasicLifecycleHookProps

(experimental) Properties for a Lifecycle 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.core.*;
 import software.amazon.awscdk.services.autoscaling.*;
 import software.amazon.awscdk.services.iam.*;
 AutoScalingGroup autoScalingGroup;
 Duration duration;
 ILifecycleHookTarget lifecycleHookTarget;
 Role role;
 LifecycleHookProps lifecycleHookProps = LifecycleHookProps.builder()
         .autoScalingGroup(autoScalingGroup)
         .lifecycleTransition(LifecycleTransition.INSTANCE_LAUNCHING)
         // the properties below are optional
         .defaultResult(DefaultResult.CONTINUE)
         .heartbeatTimeout(duration)
         .lifecycleHookName("lifecycleHookName")
         .notificationMetadata("notificationMetadata")
         .notificationTarget(lifecycleHookTarget)
         .role(role)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LifecycleHookProps.Builder A builder for LifecycleHookProps
static class	LifecycleHookProps.Jsii$Proxy An implementation for LifecycleHookProps

Method Summary

Modifier and Type	Method and Description
static LifecycleHookProps.Builder	builder()
IAutoScalingGroup	getAutoScalingGroup() (experimental) The AutoScalingGroup to add the lifecycle hook to.

Methods inherited from interface software.amazon.awscdk.services.autoscaling.BasicLifecycleHookProps

getDefaultResult, getHeartbeatTimeout, getLifecycleHookName, getLifecycleTransition, getNotificationMetadata, getNotificationTarget, getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoScalingGroup

@Stability(value=Experimental)
 @NotNull
IAutoScalingGroup getAutoScalingGroup()

(experimental) The AutoScalingGroup to add the lifecycle hook to.

builder

@Stability(value=Experimental)
static LifecycleHookProps.Builder builder()

Specified by:

builder in interface BasicLifecycleHookProps

Returns:

a LifecycleHookProps.Builder of LifecycleHookProps