Package software.amazon.awscdk.services.autoscaling

Class LifecycleHookProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.LifecycleHookProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LifecycleHookProps>

Enclosing interface:

LifecycleHookProps

@Stability(Stable)
public static final class LifecycleHookProps.Builder
extends Object
implements software.amazon.jsii.Builder<LifecycleHookProps>

A builder for LifecycleHookProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LifecycleHookProps.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup)	Sets the value of LifecycleHookProps.getAutoScalingGroup()
LifecycleHookProps	build()	Builds the configured instance.
LifecycleHookProps.Builder	defaultResult(DefaultResult defaultResult)	Sets the value of BasicLifecycleHookProps.getDefaultResult()
LifecycleHookProps.Builder	heartbeatTimeout(Duration heartbeatTimeout)	Sets the value of BasicLifecycleHookProps.getHeartbeatTimeout()
LifecycleHookProps.Builder	lifecycleHookName(String lifecycleHookName)	Sets the value of BasicLifecycleHookProps.getLifecycleHookName()
LifecycleHookProps.Builder	lifecycleTransition(LifecycleTransition lifecycleTransition)	Sets the value of BasicLifecycleHookProps.getLifecycleTransition()
LifecycleHookProps.Builder	notificationMetadata(String notificationMetadata)	Sets the value of BasicLifecycleHookProps.getNotificationMetadata()
LifecycleHookProps.Builder	notificationTarget(ILifecycleHookTarget notificationTarget)	Sets the value of BasicLifecycleHookProps.getNotificationTarget()
LifecycleHookProps.Builder	role(IRole role)	Sets the value of BasicLifecycleHookProps.getRole()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

autoScalingGroup

@Stability(Stable)
public LifecycleHookProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of LifecycleHookProps.getAutoScalingGroup()

Parameters:

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

Returns:

this

lifecycleTransition

@Stability(Stable)
public LifecycleHookProps.Builder lifecycleTransition(LifecycleTransition lifecycleTransition)

Sets the value of BasicLifecycleHookProps.getLifecycleTransition()

Parameters:

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

Returns:

this

defaultResult

@Stability(Stable)
public LifecycleHookProps.Builder defaultResult(DefaultResult defaultResult)

Sets the value of BasicLifecycleHookProps.getDefaultResult()

Parameters:

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

Returns:

this

heartbeatTimeout

@Stability(Stable)
public LifecycleHookProps.Builder heartbeatTimeout(Duration heartbeatTimeout)

Sets the value of BasicLifecycleHookProps.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Maximum time between calls to RecordLifecycleActionHeartbeat for the hook. If the lifecycle hook times out, perform the action in DefaultResult.

Returns:

this

lifecycleHookName

@Stability(Stable)
public LifecycleHookProps.Builder lifecycleHookName(String lifecycleHookName)

Sets the value of BasicLifecycleHookProps.getLifecycleHookName()

Parameters:

lifecycleHookName - Name of the lifecycle hook.

Returns:

this

notificationMetadata

@Stability(Stable)
public LifecycleHookProps.Builder notificationMetadata(String notificationMetadata)

Sets the value of BasicLifecycleHookProps.getNotificationMetadata()

Parameters:

notificationMetadata - Additional data to pass to the lifecycle hook target.

Returns:

this

notificationTarget

@Stability(Stable)
public LifecycleHookProps.Builder notificationTarget(ILifecycleHookTarget notificationTarget)

Sets the value of BasicLifecycleHookProps.getNotificationTarget()

Parameters:

notificationTarget - The target of the lifecycle hook.

Returns:

this

role

@Stability(Stable)
public LifecycleHookProps.Builder role(IRole role)

Sets the value of BasicLifecycleHookProps.getRole()

Parameters:

role - The role that allows publishing to the notification target.

Returns:

this

build

@Stability(Stable)
public LifecycleHookProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LifecycleHookProps

Throws:

NullPointerException - if any required attribute was not provided