public static interface PutLifecycleHookRequest.Builder extends AutoScalingRequest.Builder, CopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>
Modifier and Type | Method and Description |
---|---|
PutLifecycleHookRequest.Builder |
autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
|
PutLifecycleHookRequest.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.
|
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 instance state to which you want to attach the lifecycle hook.
|
PutLifecycleHookRequest.Builder |
notificationMetadata(String notificationMetadata)
Contains additional information that you want to include any time Auto Scaling sends a message to the
notification target.
|
PutLifecycleHookRequest.Builder |
notificationTargetARN(String notificationTargetARN)
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the
transition state for the lifecycle hook.
|
PutLifecycleHookRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutLifecycleHookRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutLifecycleHookRequest.Builder |
roleARN(String roleARN)
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
|
build
overrideConfiguration
copy
applyMutation, build
PutLifecycleHookRequest.Builder lifecycleHookName(String lifecycleHookName)
The name of the lifecycle hook.
lifecycleHookName
- The name of the lifecycle hook.PutLifecycleHookRequest.Builder autoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
autoScalingGroupName
- The name of the Auto Scaling group to which you want to assign the lifecycle hook.PutLifecycleHookRequest.Builder lifecycleTransition(String lifecycleTransition)
The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
lifecycleTransition
- The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types,
see DescribeLifecycleHookTypes.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
PutLifecycleHookRequest.Builder roleARN(String roleARN)
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
roleARN
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification
target.
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
PutLifecycleHookRequest.Builder notificationTargetARN(String notificationTargetARN)
The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. 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, Auto Scaling sends it a test message. Test messages contains the
following additional key/value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
notificationTargetARN
- The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the
transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. 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, Auto Scaling sends it a test message. Test messages contains
the following additional key/value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
PutLifecycleHookRequest.Builder notificationMetadata(String notificationMetadata)
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
notificationMetadata
- Contains additional information that you want to include any time Auto Scaling sends a message to the
notification target.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 is 3600 seconds (1 hour).
If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
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 is 3600 seconds (1 hour).
If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
PutLifecycleHookRequest.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. This parameter can be either CONTINUE
or ABANDON
. The
default value is ABANDON
.
defaultResult
- Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an
unexpected failure occurs. This parameter can be either CONTINUE
or ABANDON
.
The default value is ABANDON
.PutLifecycleHookRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.PutLifecycleHookRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.