software.amazon.awscdk.services.autoscaling

Class LifecycleHook.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.LifecycleHook.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LifecycleHook>

Enclosing class:

LifecycleHook

@Stability(value=Experimental)
public static final class LifecycleHook.Builder
extends Object
implements software.amazon.jsii.Builder<LifecycleHook>

(experimental) A fluent builder for LifecycleHook.

Method Summary

Modifier and Type	Method and Description
LifecycleHook.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) (experimental) The AutoScalingGroup to add the lifecycle hook to.
LifecycleHook	build()
static LifecycleHook.Builder	create(software.constructs.Construct scope, String id)
LifecycleHook.Builder	defaultResult(DefaultResult defaultResult) (experimental) The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
LifecycleHook.Builder	heartbeatTimeout(Duration heartbeatTimeout) (experimental) Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.
LifecycleHook.Builder	lifecycleHookName(String lifecycleHookName) (experimental) Name of the lifecycle hook.
LifecycleHook.Builder	lifecycleTransition(LifecycleTransition lifecycleTransition) (experimental) The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.
LifecycleHook.Builder	notificationMetadata(String notificationMetadata) (experimental) Additional data to pass to the lifecycle hook target.
LifecycleHook.Builder	notificationTarget(ILifecycleHookTarget notificationTarget) (experimental) The target of the lifecycle hook.
LifecycleHook.Builder	role(IRole role) (experimental) The role that allows publishing to the notification target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static LifecycleHook.Builder create(software.constructs.Construct scope,
                                                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of LifecycleHook.Builder.

lifecycleTransition

@Stability(value=Experimental)
public LifecycleHook.Builder lifecycleTransition(LifecycleTransition lifecycleTransition)

(experimental) The state of the Amazon EC2 instance to which you want to attach the lifecycle hook.

Parameters:

lifecycleTransition - The state of the Amazon EC2 instance to which you want to attach the lifecycle hook. This parameter is required.

Returns:

this

notificationTarget

@Stability(value=Experimental)
public LifecycleHook.Builder notificationTarget(ILifecycleHookTarget notificationTarget)

(experimental) The target of the lifecycle hook.

Parameters:

notificationTarget - The target of the lifecycle hook. This parameter is required.

Returns:

this

defaultResult

@Stability(value=Experimental)
public LifecycleHook.Builder defaultResult(DefaultResult defaultResult)

(experimental) The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Default: Continue

Parameters:

defaultResult - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter is required.

Returns:

this

heartbeatTimeout

@Stability(value=Experimental)
public LifecycleHook.Builder heartbeatTimeout(Duration heartbeatTimeout)

(experimental) Maximum time between calls to RecordLifecycleActionHeartbeat for the hook.

If the lifecycle hook times out, perform the action in DefaultResult.

Default: - No heartbeat timeout.

Parameters:

heartbeatTimeout - Maximum time between calls to RecordLifecycleActionHeartbeat for the hook. This parameter is required.

Returns:

this

lifecycleHookName

@Stability(value=Experimental)
public LifecycleHook.Builder lifecycleHookName(String lifecycleHookName)

(experimental) Name of the lifecycle hook.

Default: - Automatically generated name.

Parameters:

lifecycleHookName - Name of the lifecycle hook. This parameter is required.

Returns:

this

notificationMetadata

@Stability(value=Experimental)
public LifecycleHook.Builder notificationMetadata(String notificationMetadata)

(experimental) Additional data to pass to the lifecycle hook target.

Default: - No metadata.

Parameters:

notificationMetadata - Additional data to pass to the lifecycle hook target. This parameter is required.

Returns:

this

role

@Stability(value=Experimental)
public LifecycleHook.Builder role(IRole role)

(experimental) The role that allows publishing to the notification target.

Default: - A role is automatically created.

Parameters:

role - The role that allows publishing to the notification target. This parameter is required.

Returns:

this

autoScalingGroup

@Stability(value=Experimental)
public LifecycleHook.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

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

Parameters:

autoScalingGroup - The AutoScalingGroup to add the lifecycle hook to. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public LifecycleHook build()

Specified by:

build in interface software.amazon.jsii.Builder<LifecycleHook>