Package software.amazon.awscdk.cfnpropertymixins.services.autoscaling

Class CfnLifecycleHookMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.autoscaling.CfnLifecycleHookMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLifecycleHookMixinProps>

Enclosing interface:

CfnLifecycleHookMixinProps

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

A builder for CfnLifecycleHookMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLifecycleHookMixinProps.Builder	autoScalingGroupName(String autoScalingGroupName)	Sets the value of CfnLifecycleHookMixinProps.getAutoScalingGroupName()
CfnLifecycleHookMixinProps.Builder	autoScalingGroupName(IAutoScalingGroupRef autoScalingGroupName)	Sets the value of CfnLifecycleHookMixinProps.getAutoScalingGroupName()
CfnLifecycleHookMixinProps	build()	Builds the configured instance.
CfnLifecycleHookMixinProps.Builder	defaultResult(String defaultResult)	Sets the value of CfnLifecycleHookMixinProps.getDefaultResult()
CfnLifecycleHookMixinProps.Builder	heartbeatTimeout(Number heartbeatTimeout)	Sets the value of CfnLifecycleHookMixinProps.getHeartbeatTimeout()
CfnLifecycleHookMixinProps.Builder	lifecycleHookName(String lifecycleHookName)	Sets the value of CfnLifecycleHookMixinProps.getLifecycleHookName()
CfnLifecycleHookMixinProps.Builder	lifecycleTransition(String lifecycleTransition)	Sets the value of CfnLifecycleHookMixinProps.getLifecycleTransition()
CfnLifecycleHookMixinProps.Builder	notificationMetadata(String notificationMetadata)	Sets the value of CfnLifecycleHookMixinProps.getNotificationMetadata()
CfnLifecycleHookMixinProps.Builder	notificationTargetArn(String notificationTargetArn)	Sets the value of CfnLifecycleHookMixinProps.getNotificationTargetArn()
CfnLifecycleHookMixinProps.Builder	notificationTargetArn(ITopicRef notificationTargetArn)	Sets the value of CfnLifecycleHookMixinProps.getNotificationTargetArn()
CfnLifecycleHookMixinProps.Builder	notificationTargetArn(IQueueRef notificationTargetArn)	Sets the value of CfnLifecycleHookMixinProps.getNotificationTargetArn()
CfnLifecycleHookMixinProps.Builder	roleArn(String roleArn)	Sets the value of CfnLifecycleHookMixinProps.getRoleArn()
CfnLifecycleHookMixinProps.Builder	roleArn(IRoleRef roleArn)	Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps.Builder autoScalingGroupName(String autoScalingGroupName)

Sets the value of CfnLifecycleHookMixinProps.getAutoScalingGroupName()

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

this

autoScalingGroupName

@Stability(Stable)
public CfnLifecycleHookMixinProps.Builder autoScalingGroupName(IAutoScalingGroupRef autoScalingGroupName)

Sets the value of CfnLifecycleHookMixinProps.getAutoScalingGroupName()

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

this

defaultResult

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

Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps.Builder heartbeatTimeout(Number heartbeatTimeout)

Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps.Builder lifecycleHookName(String lifecycleHookName)

Sets the value of CfnLifecycleHookMixinProps.getLifecycleHookName()

Parameters:

lifecycleHookName - The name of the lifecycle hook.

Returns:

this

lifecycleTransition

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

Sets the value of CfnLifecycleHookMixinProps.getLifecycleTransition()

Parameters:

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 .

Returns:

this

notificationMetadata

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

Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps.Builder notificationTargetArn(String notificationTargetArn)

Sets the value of CfnLifecycleHookMixinProps.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

notificationTargetArn

@Stability(Stable)
public CfnLifecycleHookMixinProps.Builder notificationTargetArn(ITopicRef notificationTargetArn)

Sets the value of CfnLifecycleHookMixinProps.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

notificationTargetArn

@Stability(Stable)
public CfnLifecycleHookMixinProps.Builder notificationTargetArn(IQueueRef notificationTargetArn)

Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps.Builder roleArn(String roleArn)

Sets the value of CfnLifecycleHookMixinProps.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

roleArn

@Stability(Stable)
public CfnLifecycleHookMixinProps.Builder roleArn(IRoleRef roleArn)

Sets the value of CfnLifecycleHookMixinProps.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 CfnLifecycleHookMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnLifecycleHookMixinProps

Throws:

NullPointerException - if any required attribute was not provided