AutoScalingGroupLifecycleHookSpecificationArgs

data class AutoScalingGroupLifecycleHookSpecificationArgs(val defaultResult: Output<String>? = null, val heartbeatTimeout: Output<Int>? = null, val lifecycleHookName: Output<String>, val lifecycleTransition: Output<String>, val notificationMetadata: Output<String>? = null, val notificationTargetArn: Output<String>? = null, val roleArn: Output<String>? = null) : ConvertibleToJava<AutoScalingGroupLifecycleHookSpecificationArgs>

`LifecycleHookSpecification` specifies a lifecycle hook for the `LifecycleHookSpecificationList` property of the AWS::AutoScaling::AutoScalingGroup resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. You can find a sample template snippet in the Examples section of the `AWS::AutoScaling::LifecycleHook` resource.

Constructors

constructor(defaultResult: Output<String>? = null, heartbeatTimeout: Output<Int>? = null, lifecycleHookName: Output<String>, lifecycleTransition: Output<String>, notificationMetadata: Output<String>? = null, notificationTargetArn: Output<String>? = null, roleArn: Output<String>? = null)

Properties

Link copied to clipboard
val defaultResult: Output<String>? = null

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`

Link copied to clipboard
val heartbeatTimeout: Output<Int>? = null

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from `30` to `7200` seconds. The default value is `3600` seconds (1 hour).

Link copied to clipboard

The name of the lifecycle hook.

Link copied to clipboard

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

Link copied to clipboard
val notificationMetadata: Output<String>? = null

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

Link copied to clipboard
val notificationTargetArn: Output<String>? = null

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.

Link copied to clipboard
val roleArn: Output<String>? = null

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 Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

Functions

Link copied to clipboard
open override fun toJava(): AutoScalingGroupLifecycleHookSpecificationArgs