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) Defines the action the Auto Scaling group should take 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 state of the EC2 instance to which you want to attach the lifecycle hook.
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 ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition 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, for example, an Amazon SNS topic or an Amazon SQS queue.

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 state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Parameters:

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

• autoscaling:EC2_INSTANCE_LAUNCHING

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

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

defaultResult

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

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

Returns:

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

notificationTargetARN

LifecycleHookSpecification.Builder notificationTargetARN(String notificationTargetARN)

The ARN of the target that Amazon EC2 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 Amazon EC2 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

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 example, 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 example, an Amazon SNS topic or an Amazon SQS queue.

Returns:

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