Package software.amazon.awscdk.services.autoscaling

Class CfnLifecycleHookProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnLifecycleHookProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLifecycleHookProps>

Enclosing interface:

CfnLifecycleHookProps

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

A builder for CfnLifecycleHookProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLifecycleHookProps.Builder	autoScalingGroupName(String autoScalingGroupName)	Sets the value of CfnLifecycleHookProps.getAutoScalingGroupName()
CfnLifecycleHookProps	build()	Builds the configured instance.
CfnLifecycleHookProps.Builder	defaultResult(String defaultResult)	Sets the value of CfnLifecycleHookProps.getDefaultResult()
CfnLifecycleHookProps.Builder	heartbeatTimeout(Number heartbeatTimeout)	Sets the value of CfnLifecycleHookProps.getHeartbeatTimeout()
CfnLifecycleHookProps.Builder	lifecycleHookName(String lifecycleHookName)	Sets the value of CfnLifecycleHookProps.getLifecycleHookName()
CfnLifecycleHookProps.Builder	lifecycleTransition(String lifecycleTransition)	Sets the value of CfnLifecycleHookProps.getLifecycleTransition()
CfnLifecycleHookProps.Builder	notificationMetadata(String notificationMetadata)	Sets the value of CfnLifecycleHookProps.getNotificationMetadata()
CfnLifecycleHookProps.Builder	notificationTargetArn(String notificationTargetArn)	Sets the value of CfnLifecycleHookProps.getNotificationTargetArn()
CfnLifecycleHookProps.Builder	roleArn(String roleArn)	Sets the value of CfnLifecycleHookProps.getRoleArn()

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

autoScalingGroupName

@Stability(Stable)
public CfnLifecycleHookProps.Builder autoScalingGroupName(String autoScalingGroupName)

Sets the value of CfnLifecycleHookProps.getAutoScalingGroupName()

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

lifecycleTransition

@Stability(Stable)
public CfnLifecycleHookProps.Builder lifecycleTransition(String lifecycleTransition)

Sets the value of CfnLifecycleHookProps.getLifecycleTransition()

Parameters:

lifecycleTransition - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. This parameter is required.

• To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING .
• To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING .

Returns:

this

defaultResult

@Stability(Stable)
public CfnLifecycleHookProps.Builder defaultResult(String defaultResult)

Sets the value of CfnLifecycleHookProps.getDefaultResult()

Parameters:

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

Valid values: CONTINUE | ABANDON

Returns:

this

heartbeatTimeout

@Stability(Stable)
public CfnLifecycleHookProps.Builder heartbeatTimeout(Number heartbeatTimeout)

Sets the value of CfnLifecycleHookProps.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

Returns:

this

lifecycleHookName

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

Sets the value of CfnLifecycleHookProps.getLifecycleHookName()

Parameters:

lifecycleHookName - The name of the lifecycle hook.

Returns:

this

notificationMetadata

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

Sets the value of CfnLifecycleHookProps.getNotificationMetadata()

Parameters:

notificationMetadata - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Returns:

this

notificationTargetArn

@Stability(Stable)
public CfnLifecycleHookProps.Builder notificationTargetArn(String notificationTargetArn)

Sets the value of CfnLifecycleHookProps.getNotificationTargetArn()

Parameters:

notificationTargetArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

Returns:

this

roleArn

@Stability(Stable)
public CfnLifecycleHookProps.Builder roleArn(String roleArn)

Sets the value of CfnLifecycleHookProps.getRoleArn()

Parameters:

roleArn - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

Returns:

this

build

@Stability(Stable)
public CfnLifecycleHookProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnLifecycleHookProps

Throws:

NullPointerException - if any required attribute was not provided