Class LifecycleHookSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.LifecycleHookSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>
@Generated("software.amazon.awssdk:codegen") public final class LifecycleHookSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>
Describes information used to specify a lifecycle hook for an Auto Scaling group.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LifecycleHookSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LifecycleHookSpecification.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 sends notifications to 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 LifecycleHookSpecification.Builder>
serializableBuilderClass()
LifecycleHookSpecification.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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.
-
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
.
- 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
.
-
-
-
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
-
notificationTargetARN
public final String notificationTargetARN()
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- Returns:
- The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
-
roleARN
public final String roleARN()
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- Returns:
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification
target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User
Guide.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
-
toBuilder
public LifecycleHookSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>
-
builder
public static LifecycleHookSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends LifecycleHookSpecification.Builder> serializableBuilderClass()
-
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.
-
-