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
show all
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. Used in combination with CreateAutoScalingGroup.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

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

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

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. The default value is ABANDON.

Returns:

  • (String)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_timeoutInteger

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 parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

  • (Integer)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_nameString

The name of the lifecycle hook.

Returns:

  • (String)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_transitionString

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Returns:

  • (String)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_metadataString

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

Returns:

  • (String)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_arnString

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)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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_arnString

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Returns:

  • (String)


3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3229

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