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(value=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 and Description
CfnLifecycleHook.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group for the lifecycle hook.
CfnLifecycleHook	build()
static CfnLifecycleHook.Builder	create(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 instance state to which you want to attach the lifecycle hook.
CfnLifecycleHook.Builder	notificationMetadata(String notificationMetadata) Additional information that is included 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 uses to notify you when an instance is in the transition 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, for example, an Amazon SNS topic or an Amazon SQS queue.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnLifecycleHook.Builder.

autoScalingGroupName

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

The name of the Auto Scaling group for the lifecycle hook.

Parameters:

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

Returns:

this

lifecycleTransition

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

The instance state to which you want to attach the lifecycle hook. The valid values are:.

• autoscaling:EC2_INSTANCE_LAUNCHING
• autoscaling:EC2_INSTANCE_TERMINATING

Parameters:

lifecycleTransition - The instance state to which you want to attach the lifecycle hook. The valid values are:. This parameter is required.

Returns:

this

defaultResult

@Stability(value=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 valid values are CONTINUE and ABANDON (default).

For more information, see Adding lifecycle hooks in the Amazon EC2 Auto Scaling User Guide .

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=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). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

Parameters:

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

Returns:

this

lifecycleHookName

@Stability(value=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

notificationMetadata

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

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

Parameters:

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

Returns:

this

notificationTargetArn

@Stability(value=Stable)
public CfnLifecycleHook.Builder notificationTargetArn(String notificationTargetArn)

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook.

You can specify an Amazon SQS queue or an Amazon SNS topic. The notification message includes the following information: lifecycle action token, user account ID, Auto Scaling group name, lifecycle hook name, instance ID, lifecycle transition, and notification metadata.

Parameters:

notificationTargetArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This parameter is required.

Returns:

this

roleArn

@Stability(value=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 example, an Amazon SNS topic or an Amazon SQS queue.

For information about creating this role, see Configuring a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide .

Parameters:

roleArn - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnLifecycleHook build()

Specified by:

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