Class: Aws::AutoScaling::Types::PutLifecycleHookType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  SENSITIVE = []
  include Aws::Structure
end

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


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  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)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_hook_nameString

The name of the lifecycle hook.

Returns:

  • (String)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  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.

Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

  • (String)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  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)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  SENSITIVE = []
  include Aws::Structure
end

#notification_target_arnString

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Returns:

  • (String)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  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)


5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 5869

class PutLifecycleHookType < Struct.new(
  :lifecycle_hook_name,
  :auto_scaling_group_name,
  :lifecycle_transition,
  :role_arn,
  :notification_target_arn,
  :notification_metadata,
  :heartbeat_timeout,
  :default_result)
  SENSITIVE = []
  include Aws::Structure
end