Class: Ansible::Ruby::Modules::Elb_instance

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

Overview

This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. Returns fact “ec2_elbs” which is a list of elbs attached to the instance if state=absent is passed as an argument. Will be marked changed when called only if there are ELBs found to operate on.

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

#ec2_elbs ⇒ Object?

Returns List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.

Returns:

  • (Object, nil) —

    List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.



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

attribute :ec2_elbs

#enable_availability_zone ⇒ :yes, ...

Returns Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.

Returns:

  • (:yes, :no, nil) —

    Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_instance.rb', line 25

attribute :enable_availability_zone

#instance_id ⇒ Object

Returns EC2 Instance ID.

Returns:

  • (Object) —

    EC2 Instance ID



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

attribute :instance_id

#state ⇒ :present, :absent

Returns register or deregister the instance.

Returns:

  • (:present, :absent) —

    register or deregister the instance



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

attribute :state

#validate_certs ⇒ :yes, ...

Returns When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Returns:

  • (:yes, :no, nil) —

    When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.



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

attribute :validate_certs

#wait ⇒ :yes, ...

Returns Wait for instance registration or deregistration to complete successfully before returning.

Returns:

  • (:yes, :no, nil) —

    Wait for instance registration or deregistration to complete successfully before returning.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_instance.rb', line 29

attribute :wait

#wait_timeout ⇒ Integer?

Returns Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.

Returns:

  • (Integer, nil) —

    Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_instance.rb', line 37

attribute :wait_timeout