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: "XmlStringMaxLen255",
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_resultString

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)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_timeoutInteger

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)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_nameString

The name of the lifecycle hook.

Returns:

  • (String)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_transitionString

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)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_metadataString

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

Returns:

  • (String)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_arnString

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)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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_arnString

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 Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

Returns:

  • (String)


5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5261

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