software.amazon.awssdk.services.autoscaling.model

Interface LifecycleHook.Builder

All Superinterfaces:

CopyableBuilder<LifecycleHook.Builder,LifecycleHook>, SdkBuilder<LifecycleHook.Builder,LifecycleHook>

Enclosing class:

LifecycleHook

public static interface LifecycleHook.Builder
extends CopyableBuilder<LifecycleHook.Builder,LifecycleHook>

Method Summary

Modifier and Type	Method and Description
LifecycleHook.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group for the lifecycle hook.
LifecycleHook.Builder	defaultResult(String defaultResult) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
LifecycleHook.Builder	globalTimeout(Integer globalTimeout) The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state.
LifecycleHook.Builder	heartbeatTimeout(Integer heartbeatTimeout) The maximum time, in seconds, that can elapse before the lifecycle hook times out.
LifecycleHook.Builder	lifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.
LifecycleHook.Builder	lifecycleTransition(String lifecycleTransition) The state of the EC2 instance to which you want to attach the lifecycle hook.
LifecycleHook.Builder	notificationMetadata(String notificationMetadata) Additional information that you want to include any time Auto Scaling sends a message to the notification target.
LifecycleHook.Builder	notificationTargetARN(String notificationTargetARN) The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook.
LifecycleHook.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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Method Detail

lifecycleHookName

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

autoScalingGroupName

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

Returns:

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

lifecycleTransition

LifecycleHook.Builder lifecycleTransition(String lifecycleTransition)

The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

Parameters:

lifecycleTransition - The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

Returns:

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

notificationTargetARN

LifecycleHook.Builder notificationTargetARN(String notificationTargetARN)

The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

Parameters:

notificationTargetARN - The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

Returns:

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

roleARN

LifecycleHook.Builder roleARN(String roleARN)

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Parameters:

roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Returns:

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

notificationMetadata

LifecycleHook.Builder notificationMetadata(String notificationMetadata)

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

Parameters:

notificationMetadata - Additional information that you want to include any time 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

LifecycleHook.Builder heartbeatTimeout(Integer heartbeatTimeout)

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Parameters:

heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

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

globalTimeout

LifecycleHook.Builder globalTimeout(Integer globalTimeout)

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

Parameters:

globalTimeout - The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

Returns:

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

defaultResult

LifecycleHook.Builder defaultResult(String defaultResult)

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

Parameters:

defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

Returns:

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