LifecycleHook

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The name of the Auto Scaling group for the lifecycle hook.

Link copied to clipboard

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Link copied to clipboard

The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

Link copied to clipboard

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult property.

Link copied to clipboard

The name of the lifecycle hook.

Link copied to clipboard

The lifecycle transition.

Link copied to clipboard

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

Link copied to clipboard

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

Link copied to clipboard

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

Functions

Link copied to clipboard
inline fun copy(block: LifecycleHook.Builder.() -> Unit = {}): LifecycleHook
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String