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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

Describes information used to specify a lifecycle hook for an Auto Scaling group.

For more information, see [Amazon EC2 Auto Scaling lifecycle hooks] in the *Amazon EC2 Auto Scaling User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_result ⇒ String

  The action the Auto Scaling group takes 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 lifecycle transition.

• #notification_metadata ⇒ String

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

• #notification_target_arn ⇒ String

  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.

• #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

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`

Returns:

• (String)

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

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

#heartbeat_timeout ⇒ Integer

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

Returns:

• (Integer)

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

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

#lifecycle_hook_name ⇒ String

The name of the lifecycle hook.

Returns:

• (String)

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

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

#lifecycle_transition ⇒ String

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

• To create a lifecycle hook for scale-out events, specify ‘autoscaling:EC2_INSTANCE_LAUNCHING`.

• To create a lifecycle hook for scale-in events, specify ‘autoscaling:EC2_INSTANCE_TERMINATING`.

Returns:

• (String)

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

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

#notification_metadata ⇒ String

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

Returns:

• (String)

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

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

#notification_target_arn ⇒ String

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.

Returns:

• (String)

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

class LifecycleHookSpecification < Struct.new(
  :lifecycle_hook_name,
  :lifecycle_transition,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result,
  :notification_target_arn,
  :role_arn)
  SENSITIVE = []
  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. 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.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html

Returns:

• (String)

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

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