pulumi-aws-kotlin/com.pulumi.aws.autoscaling.kotlin/LifecycleHookArgs

LifecycleHookArgs

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

Provides an AutoScaling Lifecycle Hook resource.

NOTE: This provider has two types of ways you can add lifecycle hooks - via the initial_lifecycle_hook attribute from the aws.autoscaling.Group resource, or via this one. Hooks added via this resource will not be added until the autoscaling group has been created, and depending on your capacity settings, after the initial instances have been launched, creating unintended behavior. If you need hooks to run on all instances, add them with initial_lifecycle_hook in aws.autoscaling.Group, but take care to not duplicate those hooks with this resource.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Group;
import com.pulumi.aws.autoscaling.GroupArgs;
import com.pulumi.aws.autoscaling.inputs.GroupTagArgs;
import com.pulumi.aws.autoscaling.LifecycleHook;
import com.pulumi.aws.autoscaling.LifecycleHookArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var foobarGroup = new Group("foobarGroup", GroupArgs.builder()
            .availabilityZones("us-west-2a")
            .healthCheckType("EC2")
            .terminationPolicies("OldestInstance")
            .tags(GroupTagArgs.builder()
                .key("Foo")
                .value("foo-bar")
                .propagateAtLaunch(true)
                .build())
            .build());
        var foobarLifecycleHook = new LifecycleHook("foobarLifecycleHook", LifecycleHookArgs.builder()
            .autoscalingGroupName(foobarGroup.name())
            .defaultResult("CONTINUE")
            .heartbeatTimeout(2000)
            .lifecycleTransition("autoscaling:EC2_INSTANCE_LAUNCHING")
            .notificationMetadata(serializeJson(
                jsonObject(
                    jsonProperty("foo", "bar")
                )))
            .notificationTargetArn("arn:aws:sqs:us-east-1:444455556666:queue1*")
            .roleArn("arn:aws:iam::123456789012:role/S3Access")
            .build());
    }
}

Import

Using pulumi import, import AutoScaling Lifecycle Hooks using the role autoscaling_group_name and name separated by /. For example:

$ pulumi import aws:autoscaling/lifecycleHook:LifecycleHook test-lifecycle-hook asg-name/lifecycle-hook-name

Constructors

LifecycleHookArgs

fun LifecycleHookArgs(autoscalingGroupName: Output<String>? = null, defaultResult: Output<String>? = null, heartbeatTimeout: Output<Int>? = null, lifecycleTransition: Output<String>? = null, name: Output<String>? = null, notificationMetadata: Output<String>? = null, notificationTargetArn: Output<String>? = null, roleArn: Output<String>? = null)

Functions

toJava

open override fun toJava(): LifecycleHookArgs

Properties

autoscalingGroupName

val autoscalingGroupName: Output<String>? = null

Name of the Auto Scaling group to which you want to assign the lifecycle hook

defaultResult

val defaultResult: Output<String>? = null

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

heartbeatTimeout

val heartbeatTimeout: Output<Int>? = null

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter

lifecycleTransition

val lifecycleTransition: Output<String>? = null

Instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see describe-lifecycle-hook-types

name

val name: Output<String>? = null

Name of the lifecycle hook.

notificationMetadata

val notificationMetadata: Output<String>? = null

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

notificationTargetArn

val notificationTargetArn: Output<String>? = null

ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

roleArn

val roleArn: Output<String>? = null

ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.