You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/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 terminates instances. Used in response to DescribeLifecycleHooks.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

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

Returns:

  • (String)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_resultString

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

Returns:

  • (String)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_timeoutInteger

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)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_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.

Returns:

  • (Integer)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_nameString

The name of the lifecycle hook.

Returns:

  • (String)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_transitionString

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)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_metadataString

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

Returns:

  • (String)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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_arnString

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Returns:

  • (String)


3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3402

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