Class PutLifecycleHookRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest
-
- software.amazon.awssdk.services.autoscaling.model.PutLifecycleHookRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutLifecycleHookRequest extends AutoScalingRequest implements ToCopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PutLifecycleHookRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
autoScalingGroupName()
The name of the Auto Scaling group.static PutLifecycleHookRequest.Builder
builder()
String
defaultResult()
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
heartbeatTimeout()
The maximum time, in seconds, that can elapse before the lifecycle hook times out.String
lifecycleHookName()
The name of the lifecycle hook.String
lifecycleTransition()
The lifecycle transition.String
notificationMetadata()
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.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.String
roleARN()
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.List<SdkField<?>>
sdkFields()
static Class<? extends PutLifecycleHookRequest.Builder>
serializableBuilderClass()
PutLifecycleHookRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
lifecycleHookName
public final String lifecycleHookName()
The name of the lifecycle hook.
- Returns:
- The name of the lifecycle hook.
-
autoScalingGroupName
public final String autoScalingGroupName()
The name of the Auto Scaling group.
- Returns:
- The name of the Auto Scaling group.
-
lifecycleTransition
public final 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.
- Returns:
- 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.
-
-
-
roleARN
public final 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.
- Returns:
- 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.
-
notificationTargetARN
public final 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"
.- Returns:
- 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"
.
-
notificationMetadata
public final String notificationMetadata()
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- Returns:
- Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
-
heartbeatTimeout
public final Integer heartbeatTimeout()
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30
to7200
seconds. The default value is3600
seconds (1 hour).- Returns:
- The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30
to7200
seconds. The default value is3600
seconds (1 hour).
-
defaultResult
public final 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
- Returns:
- 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
-
toBuilder
public PutLifecycleHookRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutLifecycleHookRequest.Builder,PutLifecycleHookRequest>
- Specified by:
toBuilder
in classAutoScalingRequest
-
builder
public static PutLifecycleHookRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutLifecycleHookRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-