software.amazon.awssdk.services.autoscaling.model

Interface LifecycleHookSpecification.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>, SdkBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>, SdkPojo

Enclosing class:

LifecycleHookSpecification

public static interface LifecycleHookSpecification.Builder
extends SdkPojo, CopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>

Method Summary

Modifier and Type	Method and Description
LifecycleHookSpecification.Builder	defaultResult(String defaultResult) The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
LifecycleHookSpecification.Builder	heartbeatTimeout(Integer heartbeatTimeout) The maximum time, in seconds, that can elapse before the lifecycle hook times out.
LifecycleHookSpecification.Builder	lifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.
LifecycleHookSpecification.Builder	lifecycleTransition(String lifecycleTransition) The lifecycle transition.
LifecycleHookSpecification.Builder	notificationMetadata(String notificationMetadata) Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
LifecycleHookSpecification.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.
LifecycleHookSpecification.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 interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

lifecycleHookName

LifecycleHookSpecification.Builder lifecycleHookName(String lifecycleHookName)

The name of the lifecycle hook.

Parameters:

lifecycleHookName - The name of the lifecycle hook.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleTransition

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

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

Returns a reference to this object so that method calls can be chained together.

notificationMetadata

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

Returns:

Returns a reference to this object so that method calls can be chained together.

heartbeatTimeout

LifecycleHookSpecification.Builder heartbeatTimeout(Integer 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. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultResult

LifecycleHookSpecification.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. The default value is ABANDON.

Valid values: CONTINUE | ABANDON

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationTargetARN

LifecycleHookSpecification.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. You can specify an Amazon SNS topic or an Amazon SQS queue.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleARN

LifecycleHookSpecification.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 Configure a notification target for a lifecycle hook 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. For information about creating this role, see Configure a notification target for a lifecycle hook 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:

Returns a reference to this object so that method calls can be chained together.