Interface BasicLifecycleHookProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
LifecycleHookProps
- All Known Implementing Classes:
BasicLifecycleHookProps.Jsii$Proxy
,LifecycleHookProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:10.549Z")
@Stability(Stable)
public interface BasicLifecycleHookProps
extends software.amazon.jsii.JsiiSerializable
Basic 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.*; import software.amazon.awscdk.services.autoscaling.*; import software.amazon.awscdk.services.iam.*; ILifecycleHookTarget lifecycleHookTarget; Role role; BasicLifecycleHookProps basicLifecycleHookProps = BasicLifecycleHookProps.builder() .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forBasicLifecycleHookProps
static final class
An implementation forBasicLifecycleHookProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default DefaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.default Duration
Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.default String
Name of the lifecycle hook.The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.default String
Additional data to pass to the lifecycle hook target.default ILifecycleHookTarget
The target of the lifecycle hook.default IRole
getRole()
The role that allows publishing to the notification target.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getLifecycleTransition
The state of the Amazon EC2 instance to which you want to attach the lifecycle hook. -
getDefaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.Default: Continue
-
getHeartbeatTimeout
Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.If the lifecycle hook times out, perform the action in DefaultResult.
Default: - No heartbeat timeout.
-
getLifecycleHookName
Name of the lifecycle hook.Default: - Automatically generated name.
-
getNotificationMetadata
Additional data to pass to the lifecycle hook target.Default: - No metadata.
-
getNotificationTarget
The target of the lifecycle hook.Default: - No target.
-
getRole
The role that allows publishing to the notification target.Default: - A role will be created if a target is provided. Otherwise, no role is created.
-
builder
- Returns:
- a
BasicLifecycleHookProps.Builder
ofBasicLifecycleHookProps
-