Package software.amazon.awscdk.services.autoscaling

Class BasicLifecycleHookProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.BasicLifecycleHookProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BasicLifecycleHookProps>

Enclosing interface:

BasicLifecycleHookProps

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

A builder for BasicLifecycleHookProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BasicLifecycleHookProps	build()	Builds the configured instance.
BasicLifecycleHookProps.Builder	defaultResult(DefaultResult defaultResult)	Sets the value of BasicLifecycleHookProps.getDefaultResult()
BasicLifecycleHookProps.Builder	heartbeatTimeout(Duration heartbeatTimeout)	Sets the value of BasicLifecycleHookProps.getHeartbeatTimeout()
BasicLifecycleHookProps.Builder	lifecycleHookName(String lifecycleHookName)	Sets the value of BasicLifecycleHookProps.getLifecycleHookName()
BasicLifecycleHookProps.Builder	lifecycleTransition(LifecycleTransition lifecycleTransition)	Sets the value of BasicLifecycleHookProps.getLifecycleTransition()
BasicLifecycleHookProps.Builder	notificationMetadata(String notificationMetadata)	Sets the value of BasicLifecycleHookProps.getNotificationMetadata()
BasicLifecycleHookProps.Builder	notificationTarget(ILifecycleHookTarget notificationTarget)	Sets the value of BasicLifecycleHookProps.getNotificationTarget()
BasicLifecycleHookProps.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

lifecycleTransition

@Stability(Stable)
public BasicLifecycleHookProps.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 BasicLifecycleHookProps.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 BasicLifecycleHookProps.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 BasicLifecycleHookProps.Builder lifecycleHookName(String lifecycleHookName)

Sets the value of BasicLifecycleHookProps.getLifecycleHookName()

Parameters:

lifecycleHookName - Name of the lifecycle hook.

Returns:

this

notificationMetadata

@Stability(Stable)
public BasicLifecycleHookProps.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 BasicLifecycleHookProps.Builder notificationTarget(ILifecycleHookTarget notificationTarget)

Sets the value of BasicLifecycleHookProps.getNotificationTarget()

Parameters:

notificationTarget - The target of the lifecycle hook.

Returns:

this

role

@Stability(Stable)
public BasicLifecycleHookProps.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 BasicLifecycleHookProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BasicLifecycleHookProps

Throws:

NullPointerException - if any required attribute was not provided