[ aws . autoscaling ]

describe-lifecycle-hooks

Description

Gets information about the lifecycle hooks for the specified Auto Scaling group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-lifecycle-hooks
--auto-scaling-group-name <value>
[--lifecycle-hook-names <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-group-name (string)

The name of the Auto Scaling group.

--lifecycle-hook-names (list)

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe your lifecycle hooks

This example describes the lifecycle hooks for the specified Auto Scaling group.

aws autoscaling describe-lifecycle-hooks \
    --auto-scaling-group-name my-asg

Output:

{
    "LifecycleHooks": [
        {
            "GlobalTimeout": 3000,
            "HeartbeatTimeout": 30,
            "AutoScalingGroupName": "my-asg",
            "LifecycleHookName": "my-launch-hook",
            "DefaultResult": "ABANDON",
            "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"
        },
        {
            "GlobalTimeout": 6000,
            "HeartbeatTimeout": 60,
            "AutoScalingGroupName": "my-asg",
            "LifecycleHookName": "my-termination-hook",
            "DefaultResult": "CONTINUE",
            "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING"
        }
    ]
}

Output

LifecycleHooks -> (list)

The lifecycle hooks for the specified group.

(structure)

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.

LifecycleHookName -> (string)

The name of the lifecycle hook.

AutoScalingGroupName -> (string)

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

LifecycleTransition -> (string)

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

NotificationTargetARN -> (string)

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

RoleARN -> (string)

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

NotificationMetadata -> (string)

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

HeartbeatTimeout -> (integer)

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 parameter.

GlobalTimeout -> (integer)

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

DefaultResult -> (string)

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON .