Class: Ansible::Ruby::Modules::Ec2_elb_lb

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ec2_elb_lb

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb

Overview

Returns information about the load balancer. Will be marked changed when called only if state is changed.

Instance Method Summary

• #access_logs ⇒ Hash^?

  An associative array of access logs configuration settings (see example).

• #connection_draining_timeout ⇒ Integer^?

  Wait a specified timeout allowing connections to drain before terminating an instance.

• #cross_az_load_balancing ⇒ :yes, ...

  Distribute load across all configured Availability Zones.

• #health_check ⇒ Hash^?

  An associative array of health check configuration settings (see example).

• #idle_timeout ⇒ Integer^?

  ELB connections from clients and to servers are timed out after this amount of time.

• #instance_ids ⇒ Boolean^?

  List of instance ids to attach to this ELB.

• #listeners ⇒ Array<Hash>, ...

  List of ports/protocols for this ELB to listen on (see example).

• #name ⇒ String

  The name of the ELB.

• #purge_instance_ids ⇒ Boolean^?

  Purge existing instance ids on ELB that are not found in instance_ids.

• #purge_listeners ⇒ Boolean^?

  Purge existing listeners on ELB that are not found in listeners.

• #purge_subnets ⇒ Boolean^?

  Purge existing subnet on ELB that are not found in subnets.

• #purge_zones ⇒ Boolean^?

  Purge existing availability zones on ELB that are not found in zones.

• #scheme ⇒ String^?

  The scheme to use when creating the ELB.

• #security_group_ids ⇒ Array<String>, ...

  A list of security groups to apply to the elb.

• #security_group_names ⇒ Object^?

  A list of security group names to apply to the elb.

• #state ⇒ :present, :absent

  Create or destroy the ELB.

• #stickiness ⇒ Hash^?

  An associative array of stickness policy settings.

• #subnets ⇒ Array<String>, ...

  A list of VPC subnets to use when creating ELB.

• #tags ⇒ Hash^?

  An associative array of tags.

• #validate_certs ⇒ :yes, ...

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

• #wait ⇒ Boolean^?

  When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.

• #wait_timeout ⇒ Integer^?

  Used in conjunction with wait.

• #zones ⇒ Array<String>, ...

  List of availability zones to enable on this ELB.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#access_logs ⇒ Hash^?

Returns An associative array of access logs configuration settings (see example).

Returns:

• (Hash, nil) —

  An associative array of access logs configuration settings (see example)

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 55

attribute :access_logs

#connection_draining_timeout ⇒ Integer^?

Returns Wait a specified timeout allowing connections to drain before terminating an instance.

Returns:

• (Integer, nil) —

  Wait a specified timeout allowing connections to drain before terminating an instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 75

attribute :connection_draining_timeout

#cross_az_load_balancing ⇒ :yes, ...

Returns Distribute load across all configured Availability Zones.

Returns:

• (:yes, :no, nil) —

  Distribute load across all configured Availability Zones

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 83

attribute :cross_az_load_balancing

#health_check ⇒ Hash^?

Returns An associative array of health check configuration settings (see example).

Returns:

• (Hash, nil) —

  An associative array of health check configuration settings (see example)

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 51

attribute :health_check

#idle_timeout ⇒ Integer^?

Returns ELB connections from clients and to servers are timed out after this amount of time.

Returns:

• (Integer, nil) —

  ELB connections from clients and to servers are timed out after this amount of time

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 79

attribute :idle_timeout

#instance_ids ⇒ Boolean^?

Returns List of instance ids to attach to this ELB.

Returns:

• (Boolean, nil) —

  List of instance ids to attach to this ELB

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 28

attribute :instance_ids

#listeners ⇒ Array<Hash>, ...

Returns List of ports/protocols for this ELB to listen on (see example).

Returns:

• (Array<Hash>, Hash, nil) —

  List of ports/protocols for this ELB to listen on (see example)

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 20

attribute :listeners

#name ⇒ String

Returns The name of the ELB.

Returns:

• (String) —

  The name of the ELB

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 16

attribute :name

#purge_instance_ids ⇒ Boolean^?

Returns Purge existing instance ids on ELB that are not found in instance_ids.

Returns:

• (Boolean, nil) —

  Purge existing instance ids on ELB that are not found in instance_ids

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 32

attribute :purge_instance_ids

#purge_listeners ⇒ Boolean^?

Returns Purge existing listeners on ELB that are not found in listeners.

Returns:

• (Boolean, nil) —

  Purge existing listeners on ELB that are not found in listeners

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 24

attribute :purge_listeners

#purge_subnets ⇒ Boolean^?

Returns Purge existing subnet on ELB that are not found in subnets.

Returns:

• (Boolean, nil) —

  Purge existing subnet on ELB that are not found in subnets

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 63

attribute :purge_subnets

#purge_zones ⇒ Boolean^?

Returns Purge existing availability zones on ELB that are not found in zones.

Returns:

• (Boolean, nil) —

  Purge existing availability zones on ELB that are not found in zones

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 40

attribute :purge_zones

#scheme ⇒ String^?

Returns The scheme to use when creating the ELB. For a private VPC-visible ELB use ‘internal’.

Returns:

• (String, nil) —

  The scheme to use when creating the ELB. For a private VPC-visible ELB use ‘internal’.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 67

attribute :scheme

#security_group_ids ⇒ Array<String>, ...

Returns A list of security groups to apply to the elb.

Returns:

• (Array<String>, String, nil) —

  A list of security groups to apply to the elb

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 44

attribute :security_group_ids

#security_group_names ⇒ Object^?

Returns A list of security group names to apply to the elb.

Returns:

• (Object, nil) —

  A list of security group names to apply to the elb

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 48

attribute :security_group_names

#state ⇒ :present, :absent

Returns Create or destroy the ELB.

Returns:

• (:present, :absent) —

  Create or destroy the ELB

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 12

attribute :state

#stickiness ⇒ Hash^?

Returns An associative array of stickness policy settings. Policy will be applied to all listeners ( see example ).

Returns:

• (Hash, nil) —

  An associative array of stickness policy settings. Policy will be applied to all listeners ( see example )

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 87

attribute :stickiness

#subnets ⇒ Array<String>, ...

Returns A list of VPC subnets to use when creating ELB. Zones should be empty if using this.

Returns:

• (Array<String>, String, nil) —

  A list of VPC subnets to use when creating ELB. Zones should be empty if using this.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 59

attribute :subnets

#tags ⇒ Hash^?

Returns An associative array of tags. To delete all tags, supply an empty dict.

Returns:

• (Hash, nil) —

  An associative array of tags. To delete all tags, supply an empty dict.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 99

attribute :tags

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

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 71

attribute :validate_certs

#wait ⇒ Boolean^?

Returns When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.

Returns:

• (Boolean, nil) —

  When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 91

attribute :wait

#wait_timeout ⇒ Integer^?

Returns Used in conjunction with wait. Number of seconds to wait for the elb to be terminated. A maximum of 600 seconds (10 minutes) is allowed.

Returns:

• (Integer, nil) —

  Used in conjunction with wait. Number of seconds to wait for the elb to be terminated. A maximum of 600 seconds (10 minutes) is allowed.

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/ec2_elb_lb.rb', line 95

attribute :wait_timeout

#zones ⇒ Array<String>, ...

Returns List of availability zones to enable on this ELB.

Returns:

• (Array<String>, String, nil) —

  List of availability zones to enable on this ELB

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

attribute :zones