public static interface LifecycleHookSpecification.Builder extends CopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>
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 Auto Scaling sends a message to the notification
target.
|
LifecycleHookSpecification.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.
|
LifecycleHookSpecification.Builder |
roleARN(String roleARN)
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
|
copy
applyMutation, build
LifecycleHookSpecification.Builder lifecycleHookName(String lifecycleHookName)
The name of the lifecycle hook.
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. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
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.LifecycleHookSpecification.Builder notificationMetadata(String notificationMetadata)
Additional information that you want to include any time Auto Scaling sends a message to the notification target.
notificationMetadata
- Additional information that you want to include any time Auto Scaling sends a message to the
notification target.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, 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. If the lifecycle
hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from
timing out by calling RecordLifecycleActionHeartbeat.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 CONTINUE
.
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
.LifecycleHookSpecification.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.
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.LifecycleHookSpecification.Builder roleARN(String roleARN)
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
roleARN
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification
target.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.