Class: Ansible::Ruby::Modules::Elb_target

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/elb_target.rb

Overview

Used to register or deregister a target in a target group

Instance Method Summary

• #deregister_unused ⇒ Symbol^?

  The default behaviour for targets that are unused is to leave them registered.

• #state ⇒ :present, :absent

  Register or deregister the target.

• #target_az ⇒ Object^?

  An Availability Zone or all.

• #target_group_arn ⇒ Object^?

  The Amazon Resource Name (ARN) of the target group.

• #target_group_name ⇒ String^?

  The name of the target group.

• #target_id ⇒ String

  The ID of the target.

• #target_port ⇒ String^?

  The port on which the target is listening.

• #target_status ⇒ :initial, ...

  Blocks and waits for the target status to equal given value.

• #target_status_timeout ⇒ Integer^?

  Maximum time in seconds to wait for target_status change.

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

#deregister_unused ⇒ Symbol^?

Returns The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them set I(deregister_unused) to yes.

Returns:

• (Symbol, nil) —

  The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them set I(deregister_unused) to yes.

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

attribute :deregister_unused

#state ⇒ :present, :absent

Returns Register or deregister the target.

Returns:

• (:present, :absent) —

  Register or deregister the target.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target.rb', line 42

attribute :state

#target_az ⇒ Object^?

Returns An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance.

Returns:

• (Object, nil) —

  An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance.

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

attribute :target_az

#target_group_arn ⇒ Object^?

Returns The Amazon Resource Name (ARN) of the target group. Mutually exclusive of I(target_group_name).

Returns:

• (Object, nil) —

  The Amazon Resource Name (ARN) of the target group. Mutually exclusive of I(target_group_name).

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target.rb', line 19

attribute :target_group_arn

#target_group_name ⇒ String^?

Returns The name of the target group. Mutually exclusive of I(target_group_arn).

Returns:

• (String, nil) —

  The name of the target group. Mutually exclusive of I(target_group_arn).

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

attribute :target_group_name

#target_id ⇒ String

Returns The ID of the target.

Returns:

• (String) —

  The ID of the target.

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

attribute :target_id

#target_port ⇒ String^?

Returns The port on which the target is listening. You can specify a port override. If a target is already registered, you can register it again using a different port.

Returns:

• (String, nil) —

  The port on which the target is listening. You can specify a port override. If a target is already registered, you can register it again using a different port.

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

attribute :target_port

#target_status ⇒ :initial, ...

Returns Blocks and waits for the target status to equal given value. For more detail on target status see U(docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states).

Returns:

• (:initial, :healthy, :unhealthy, :unused, :draining, :unavailable, nil) —

  Blocks and waits for the target status to equal given value. For more detail on target status see U(docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states)

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target.rb', line 34

attribute :target_status

#target_status_timeout ⇒ Integer^?

Returns Maximum time in seconds to wait for target_status change.

Returns:

• (Integer, nil) —

  Maximum time in seconds to wait for target_status change

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target.rb', line 38

attribute :target_status_timeout