software.amazon.awssdk.services.autoscaling.model

Interface PutLifecycleHookRequest.Builder

All Superinterfaces:

AutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>, SdkBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutLifecycleHookRequest

public static interface PutLifecycleHookRequest.Builder
extends AutoScalingRequest.Builder, SdkPojo, CopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>

Method Summary

Modifier and Type	Method and Description
PutLifecycleHookRequest.Builder	autoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
PutLifecycleHookRequest.Builder	defaultResult(String defaultResult) The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
PutLifecycleHookRequest.Builder	heartbeatTimeout(Integer heartbeatTimeout) The maximum time, in seconds, that can elapse before the lifecycle hook times out.
PutLifecycleHookRequest.Builder	lifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.
PutLifecycleHookRequest.Builder	lifecycleTransition(String lifecycleTransition) The lifecycle transition.
PutLifecycleHookRequest.Builder	notificationMetadata(String notificationMetadata) Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
PutLifecycleHookRequest.Builder	notificationTargetARN(String notificationTargetARN) The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook.
PutLifecycleHookRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutLifecycleHookRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutLifecycleHookRequest.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.services.autoscaling.model.AutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

PutLifecycleHookRequest.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

lifecycleTransition

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

Required for new lifecycle hooks, but optional when updating existing hooks.

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.

Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

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

roleARN

PutLifecycleHookRequest.Builder roleARN(String roleARN)

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Parameters:

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

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

notificationTargetARN

PutLifecycleHookRequest.Builder notificationTargetARN(String notificationTargetARN)

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

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 a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Returns:

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

notificationMetadata

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

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

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

overrideConfiguration

PutLifecycleHookRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutLifecycleHookRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder