software.amazon.awscdk.services.autoscaling

Class CfnLifecycleHookProps.Builder

java.lang.Object

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

Enclosing interface:

CfnLifecycleHookProps

public static final class CfnLifecycleHookProps.Builder
extends java.lang.Object

A builder for CfnLifecycleHookProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Builder

public Builder()

Method Detail

autoScalingGroupName

public CfnLifecycleHookProps.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)

Sets the value of CfnLifecycleHookProps.getAutoScalingGroupName()

Parameters:

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

Returns:

this

lifecycleTransition

public CfnLifecycleHookProps.Builder lifecycleTransition(java.lang.String lifecycleTransition)

Sets the value of CfnLifecycleHookProps.getLifecycleTransition()

Parameters:

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

• autoscaling:EC2_INSTANCE_LAUNCHING
• autoscaling:EC2_INSTANCE_TERMINATING

Returns:

this

defaultResult

public CfnLifecycleHookProps.Builder defaultResult(java.lang.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 valid values are CONTINUE and ABANDON (default).

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

Returns:

this

heartbeatTimeout

public CfnLifecycleHookProps.Builder heartbeatTimeout(java.lang.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). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

Returns:

this

lifecycleHookName

public CfnLifecycleHookProps.Builder lifecycleHookName(java.lang.String lifecycleHookName)

Sets the value of CfnLifecycleHookProps.getLifecycleHookName()

Parameters:

lifecycleHookName - The name of the lifecycle hook.

Returns:

this

notificationMetadata

public CfnLifecycleHookProps.Builder notificationMetadata(java.lang.String notificationMetadata)

Sets the value of CfnLifecycleHookProps.getNotificationMetadata()

Parameters:

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

Returns:

this

notificationTargetArn

public CfnLifecycleHookProps.Builder notificationTargetArn(java.lang.String notificationTargetArn)

Sets the value of CfnLifecycleHookProps.getNotificationTargetArn()

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

Returns:

this

roleArn

public CfnLifecycleHookProps.Builder roleArn(java.lang.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 example, an Amazon SNS topic or an Amazon SQS queue. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide .

Returns:

this

build

public CfnLifecycleHookProps build()

Builds the configured instance.

Returns:

a new instance of CfnLifecycleHookProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided