Class: Ansible::Ruby::Modules::Ec2_asg_lifecycle_hook

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb

Overview

When no given Hook found, will create one. In case Hook found, but provided parameters are differes, will update existing Hook. In case state=absent and Hook exists, will delete it.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#autoscaling_group_name ⇒ String

Returns The name of the Auto Scaling group to which you want to assign the lifecycle hook.

Returns:

  • (String) —

    The name of the Auto Scaling group to which you want to assign the lifecycle hook.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 22

attribute :autoscaling_group_name

#default_result ⇒ :ABANDON, ...

Returns Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON.

Returns:

  • (:ABANDON, :CONTINUE, nil) —

    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 43

attribute :default_result

#heartbeat_timeout ⇒ String?

Returns The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

  • (String, nil) —

    The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 39

attribute :heartbeat_timeout

#lifecycle_hook_name ⇒ String

Returns The name of the lifecycle hook.

Returns:

  • (String) —

    The name of the lifecycle hook.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 18

attribute :lifecycle_hook_name

#notification_meta_data ⇒ Object?

Returns Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

Returns:

  • (Object, nil) —

    Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 36

attribute :notification_meta_data

#notification_target_arn ⇒ Object?

Returns The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

Returns:

  • (Object, nil) —

    The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 33

attribute :notification_target_arn

#role_arn ⇒ Object?

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

Returns:

  • (Object, nil) —

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



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 30

attribute :role_arn

#state ⇒ :present, ...

Returns Create or delete Lifecycle Hook. Present updates existing one or creates if not found.

Returns:

  • (:present, :absent, nil) —

    Create or delete Lifecycle Hook. Present updates existing one or creates if not found.



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 14

attribute :state

#transition ⇒ :"autoscaling:EC2_INSTANCE_TERMINATING", :"autoscaling:EC2_INSTANCE_LAUNCHING"

Returns The instance state to which you want to attach the lifecycle hook.

Returns:

  • (:"autoscaling:EC2_INSTANCE_TERMINATING", :"autoscaling:EC2_INSTANCE_LAUNCHING") —

    The instance state to which you want to attach the lifecycle hook.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_asg_lifecycle_hook.rb', line 26

attribute :transition