@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
date="2022-07-01T09:58:40.497Z")
public interface BasicLifecycleHookProps
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.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.core.*; 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();
Modifier and Type | Interface and Description |
---|---|
static class |
BasicLifecycleHookProps.Builder
A builder for
BasicLifecycleHookProps |
static class |
BasicLifecycleHookProps.Jsii$Proxy
An implementation for
BasicLifecycleHookProps |
Modifier and Type | Method and Description |
---|---|
static BasicLifecycleHookProps.Builder |
builder() |
default DefaultResult |
getDefaultResult()
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
|
default Duration |
getHeartbeatTimeout()
Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.
|
default java.lang.String |
getLifecycleHookName()
Name of the lifecycle hook.
|
LifecycleTransition |
getLifecycleTransition()
The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.
|
default java.lang.String |
getNotificationMetadata()
Additional data to pass to the lifecycle hook target.
|
default ILifecycleHookTarget |
getNotificationTarget()
The target of the lifecycle hook.
|
default IRole |
getRole()
The role that allows publishing to the notification target.
|
LifecycleTransition getLifecycleTransition()
default DefaultResult getDefaultResult()
Default: Continue
default Duration getHeartbeatTimeout()
If the lifecycle hook times out, perform the action in DefaultResult.
Default: - No heartbeat timeout.
default java.lang.String getLifecycleHookName()
Default: - Automatically generated name.
default java.lang.String getNotificationMetadata()
Default: - No metadata.
default ILifecycleHookTarget getNotificationTarget()
Default: - No target.
default IRole getRole()
Default: - A role will be created if a target is provided. Otherwise, no role is created.
static BasicLifecycleHookProps.Builder builder()
BasicLifecycleHookProps.Builder
of BasicLifecycleHookProps