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

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

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::LifecycleHookSpecification

Defined in:

gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass LifecycleHookSpecification data as a 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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #default_result ⇒ String

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

• #heartbeat_timeout ⇒ Integer

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

• #lifecycle_hook_name ⇒ String

  The name of the lifecycle hook.

• #lifecycle_transition ⇒ String

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

• #notification_metadata ⇒ String

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

• #notification_target_arn ⇒ 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_arn ⇒ String

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

Instance Attribute Details

#default_result ⇒ String

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)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#heartbeat_timeout ⇒ Integer

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)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#lifecycle_hook_name ⇒ String

The name of the lifecycle hook.

Returns:

• (String)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#lifecycle_transition ⇒ String

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)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#notification_metadata ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#notification_target_arn ⇒ String

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)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2769

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  include Aws::Structure
end