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

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)


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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.

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)


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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)


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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)


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

  • (String)


5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5221

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