You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::Types::LifecycleHookSpecification

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LifecycleHookSpecification as input to an Aws::Client method, you can use a vanilla Hash:

{
  lifecycle_hook_name: "AsciiStringMaxLen255", # required
  lifecycle_transition: "LifecycleTransition", # required
  notification_metadata: "XmlStringMaxLen1023",
  heartbeat_timeout: 1,
  default_result: "LifecycleActionResult",
  notification_target_arn: "NotificationTargetResourceName",
  role_arn: "ResourceName",
}

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

For more information, see Auto Scaling Lifecycle Hooks in the Auto Scaling User Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#default_resultString

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

Returns:

  • (String)

    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.

#heartbeat_timeoutInteger

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

  • (Integer)

    The maximum time, in seconds, that can elapse before the lifecycle hook times out.

#lifecycle_hook_nameString

The name of the lifecycle hook.

Returns:

  • (String)

    The name of the lifecycle hook.

#lifecycle_transitionString

The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

Returns:

  • (String)

    The state of the EC2 instance to which you want to attach the lifecycle hook.

#notification_metadataString

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

Returns:

  • (String)

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

#notification_target_arnString

The ARN of the target that 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.

Returns:

  • (String)

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

#role_arnString

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

Returns:

  • (String)

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