Package software.amazon.awscdk.services.autoscaling

Class CfnLifecycleHook.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnLifecycleHook.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLifecycleHook>

Enclosing class:

CfnLifecycleHook

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

A fluent builder for CfnLifecycleHook.

Method Summary

Modifier and Type	Method	Description
CfnLifecycleHook.Builder	autoScalingGroupName(String autoScalingGroupName)	The name of the Auto Scaling group.
CfnLifecycleHook	build()
static CfnLifecycleHook.Builder	create(software.constructs.Construct scope, String id)
CfnLifecycleHook.Builder	defaultResult(String defaultResult)	The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
CfnLifecycleHook.Builder	heartbeatTimeout(Number heartbeatTimeout)	The maximum time, in seconds, that can elapse before the lifecycle hook times out.
CfnLifecycleHook.Builder	lifecycleHookName(String lifecycleHookName)	The name of the lifecycle hook.
CfnLifecycleHook.Builder	lifecycleTransition(String lifecycleTransition)	The lifecycle transition.
CfnLifecycleHook.Builder	notificationMetadata(String notificationMetadata)	Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
CfnLifecycleHook.Builder	notificationTargetArn(String 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.
CfnLifecycleHook.Builder	roleArn(String roleArn)	The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnLifecycleHook.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLifecycleHook.Builder.

autoScalingGroupName

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

The name of the Auto Scaling group.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-autoscalinggroupname

lifecycleTransition

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

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

• 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 .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecycletransition

defaultResult

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-defaultresult

heartbeatTimeout

@Stability(Stable)
public CfnLifecycleHook.Builder heartbeatTimeout(Number 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).

Parameters:

heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-heartbeattimeout

lifecycleHookName

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

The name of the lifecycle hook.

Parameters:

lifecycleHookName - The name of the lifecycle hook. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-lifecyclehookname

notificationMetadata

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationmetadata

notificationTargetArn

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

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-notificationtargetarn

roleArn

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

Parameters:

roleArn - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-lifecyclehook.html#cfn-autoscaling-lifecyclehook-rolearn

build

@Stability(Stable)
public CfnLifecycleHook build()

Specified by:

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

Returns:

a newly built instance of CfnLifecycleHook.