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. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_scaling_group_name ⇒ String

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

• #default_result ⇒ String

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

• #notification_metadata ⇒ String

  Additional information that is included 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 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 (an Amazon SNS topic or an Amazon SQS queue).

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 4623

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_result ⇒ String

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Valid values: ‘CONTINUE` | `ABANDON`

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#global_timeout ⇒ Integer

The maximum time, in seconds, that an instance can remain in a 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 4623

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)
  SENSITIVE = []
  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 action that you specified in the ‘DefaultResult` property.

Returns:

• (Integer)

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

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_transition ⇒ String

The lifecycle transition.

Valid values: ‘autoscaling:EC2_INSTANCE_LAUNCHING` | `autoscaling:EC2_INSTANCE_TERMINATING`

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#notification_metadata ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  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 a wait state for the lifecycle hook.

Returns:

• (String)

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

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)
  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 (an Amazon SNS topic or an Amazon SQS queue).

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end