Class: Aws::AutoScaling::Types::LifecycleHook

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::LifecycleHook

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

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

For more information, see [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

Instance Attribute Summary

• #auto_scaling_group_name ⇒ String

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

• #default_result ⇒ String

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

• #global_timeout ⇒ Integer

  The maximum time, in seconds, that an instance can remain in a ‘Pending:Wait` or `Terminating:Wait` state.

• #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 to attach the lifecycle hook.

• #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 ARN of the target that Amazon EC2 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

#auto_scaling_group_name ⇒ String

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

Returns:

• (String)

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

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

#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`. The default value is `CONTINUE`.

Returns:

• (String)

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

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

#global_timeout ⇒ 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.

Returns:

• (Integer)

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

class LifecycleHook < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :notification_target_arn,
  :role_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :global_timeout,
  :default_result)
  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, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

• (Integer)

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

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

#lifecycle_hook_name ⇒ String

The name of the lifecycle hook.

Returns:

• (String)

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

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

#lifecycle_transition ⇒ 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

Returns:

• (String)

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

class LifecycleHook < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :notification_target_arn,
  :role_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :global_timeout,
  :default_result)
  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 3005

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

#notification_target_arn ⇒ 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.

Returns:

• (String)

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

class LifecycleHook < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :notification_target_arn,
  :role_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :global_timeout,
  :default_result)
  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 'lib/aws-sdk-autoscaling/types.rb', line 3005

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