Class: Ansible::Ruby::Modules::Elb_target_group

Inherits:

Object
Ansible::Ruby::Models::Base
Base
Ansible::Ruby::Modules::Elb_target_group

Defined in:: lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb

Overview

Manage an AWS Elastic Load Balancer target group. See U(docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) or U(docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html) for details.

Instance Method Summary collapse

#deregistration_delay_timeout ⇒ Object^?

The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused.
#health_check_interval ⇒ Object^?

The approximate amount of time, in seconds, between health checks of an individual target.
#health_check_path ⇒ String^?

The ping path that is the destination on the targets for health checks.
#health_check_port ⇒ String^?

The port the load balancer uses when performing health checks on targets.
#health_check_protocol ⇒ :http, ...

The protocol the load balancer uses when performing health checks on targets.
#health_check_timeout ⇒ Object^?

The amount of time, in seconds, during which no response from a target means a failed health check.
#healthy_threshold_count ⇒ Object^?

The number of consecutive health checks successes required before considering an unhealthy target healthy.
#modify_targets ⇒ Boolean^?

Whether or not to alter existing targets in the group to match what is passed with the module.
#name ⇒ String

The name of the target group.
#port ⇒ Integer^?

The port on which the targets receive traffic.
#protocol ⇒ :http, ...

The protocol to use for routing traffic to the targets.
#purge_tags ⇒ Boolean^?

If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter.
#state ⇒ :present, :absent

Create or destroy the target group.
#stickiness_enabled ⇒ Symbol^?

Indicates whether sticky sessions are enabled.
#stickiness_lb_cookie_duration ⇒ Object^?

The time period, in seconds, during which requests from a client should be routed to the same target.
#stickiness_type ⇒ String^?

The type of sticky sessions.
#successful_response_codes ⇒ Array<Integer>, ...

The HTTP codes to use when checking for a successful response from a target.
#tags ⇒ Object^?

A dictionary of one or more tags to assign to the target group.
#target_type ⇒ :instance, ...

The type of target that you must specify when registering targets with this target group.
#targets ⇒ Array<Hash>, ...

A list of targets to assign to the target group.
#unhealthy_threshold_count ⇒ Object^?

The number of consecutive health check failures required before considering a target unhealthy.
#vpc_id ⇒ String^?

The identifier of the virtual private cloud (VPC).
#wait ⇒ Symbol^?

Whether or not to wait for the target group.
#wait_timeout ⇒ Integer^?

The time to wait for the target group.

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

#deregistration_delay_timeout ⇒ `Object`^?

Returns The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds.

Returns:

(Object, nil) —

The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds.

12	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 12 attribute :deregistration_delay_timeout

#health_check_interval ⇒ `Object`^?

Returns The approximate amount of time, in seconds, between health checks of an individual target.

Returns:

(Object, nil) —

The approximate amount of time, in seconds, between health checks of an individual target.

27	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 27 attribute :health_check_interval

#health_check_path ⇒ `String`^?

Returns The ping path that is the destination on the targets for health checks. The path must be defined in order to set a health check.

Returns:

(String, nil) —

The ping path that is the destination on the targets for health checks. The path must be defined in order to set a health check.

23	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 23 attribute :health_check_path

#health_check_port ⇒ `String`^?

Returns The port the load balancer uses when performing health checks on targets. Can be set to ‘traffic-port’ to match target port.

Returns:

(String, nil) —

The port the load balancer uses when performing health checks on targets. Can be set to ‘traffic-port’ to match target port.

19	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 19 attribute :health_check_port

#health_check_protocol ⇒ `:http`, ...

Returns The protocol the load balancer uses when performing health checks on targets.

Returns:

(:http, :https, :tcp, nil) —

The protocol the load balancer uses when performing health checks on targets.

15	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 15 attribute :health_check_protocol

#health_check_timeout ⇒ `Object`^?

Returns The amount of time, in seconds, during which no response from a target means a failed health check.

Returns:

(Object, nil) —

The amount of time, in seconds, during which no response from a target means a failed health check.

30	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 30 attribute :health_check_timeout

#healthy_threshold_count ⇒ `Object`^?

Returns The number of consecutive health checks successes required before considering an unhealthy target healthy.

Returns:

(Object, nil) —

The number of consecutive health checks successes required before considering an unhealthy target healthy.

33	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 33 attribute :healthy_threshold_count

#modify_targets ⇒ `Boolean`^?

Returns Whether or not to alter existing targets in the group to match what is passed with the module.

Returns:

(Boolean, nil) —

Whether or not to alter existing targets in the group to match what is passed with the module

36	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 36 attribute :modify_targets

#name ⇒ `String`

Returns The name of the target group.

Returns:

(String) —

The name of the target group.

40	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 40 attribute :name

#port ⇒ `Integer`^?

Returns The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if I(state) is C(present).

Returns:

(Integer, nil) —

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if I(state) is C(present).

44	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 44 attribute :port

#protocol ⇒ `:http`, ...

Returns The protocol to use for routing traffic to the targets. Required when I(state) is C(present).

Returns:

(:http, :https, :tcp, nil) —

The protocol to use for routing traffic to the targets. Required when I(state) is C(present).

48	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 48 attribute :protocol

#purge_tags ⇒ `Boolean`^?

Returns If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the tag parameter is not set then tags will not be modified.

Returns:

(Boolean, nil) —

If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the tag parameter is not set then tags will not be modified.

52	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 52 attribute :purge_tags

#state ⇒ `:present`, `:absent`

Returns Create or destroy the target group.

Returns:

(:present, :absent) —

Create or destroy the target group.

56	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 56 attribute :state

#stickiness_enabled ⇒ `Symbol`^?

Returns Indicates whether sticky sessions are enabled.

Returns:

(Symbol, nil) —

Indicates whether sticky sessions are enabled.

60	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 60 attribute :stickiness_enabled

#stickiness_lb_cookie_duration ⇒ `Object`^?

Returns The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds).

Returns:

(Object, nil) —

The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds).

64	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 64 attribute :stickiness_lb_cookie_duration

#stickiness_type ⇒ `String`^?

Returns The type of sticky sessions. The possible value is lb_cookie.

Returns:

(String, nil) —

The type of sticky sessions. The possible value is lb_cookie.

67	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 67 attribute :stickiness_type

#successful_response_codes ⇒ `Array<Integer>`, ...

Returns The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

Returns:

(Array<Integer>, Integer, nil) —

The HTTP codes to use when checking for a successful response from a target. You can specify multiple values (for example, “200,202”) or a range of values (for example, “200-299”).

71	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 71 attribute :successful_response_codes

#tags ⇒ `Object`^?

Returns A dictionary of one or more tags to assign to the target group.

Returns:

(Object, nil) —

A dictionary of one or more tags to assign to the target group.

75	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 75 attribute :tags

#target_type ⇒ `:instance`, ...

Returns The type of target that you must specify when registering targets with this target group. The possible values are C(instance) (targets are specified by instance ID) or C(ip) (targets are specified by IP address). Note that you can’t specify targets for a target group using both instance IDs and IP addresses. If the target type is ip, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can’t specify publicly routable IP addresses.

Returns:

(:instance, :ip, nil) —

The type of target that you must specify when registering targets with this target group. The possible values are C(instance) (targets are specified by instance ID) or C(ip) (targets are specified by IP address). Note that you can’t specify targets for a target group using both instance IDs and IP addresses. If the target type is ip, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can’t specify publicly routable IP addresses.

78	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 78 attribute :target_type

#targets ⇒ `Array<Hash>`, ...

Returns A list of targets to assign to the target group. This parameter defaults to an empty list. Unless you set the ‘modify_targets’ parameter then all existing targets will be removed from the group. The list should be an Id and a Port parameter. See the Examples for detail.

Returns:

(Array<Hash>, Hash, nil) —

A list of targets to assign to the target group. This parameter defaults to an empty list. Unless you set the ‘modify_targets’ parameter then all existing targets will be removed from the group. The list should be an Id and a Port parameter. See the Examples for detail.

82	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 82 attribute :targets

#unhealthy_threshold_count ⇒ `Object`^?

Returns The number of consecutive health check failures required before considering a target unhealthy.

Returns:

(Object, nil) —

The number of consecutive health check failures required before considering a target unhealthy.

86	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 86 attribute :unhealthy_threshold_count

#vpc_id ⇒ `String`^?

Returns The identifier of the virtual private cloud (VPC). Required when I(state) is C(present).

Returns:

(String, nil) —

The identifier of the virtual private cloud (VPC). Required when I(state) is C(present).

89	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 89 attribute :vpc_id

#wait ⇒ `Symbol`^?

Returns Whether or not to wait for the target group.

Returns:

(Symbol, nil) —

Whether or not to wait for the target group.

93	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 93 attribute :wait

#wait_timeout ⇒ `Integer`^?

Returns The time to wait for the target group.

Returns:

(Integer, nil) —

The time to wait for the target group.

97	# File 'lib/ansible/ruby/modules/generated/cloud/amazon/elb_target_group.rb', line 97 attribute :wait_timeout

Class: Ansible::Ruby::Modules::Elb_target_group

Overview

Instance Method Summary collapse

Methods inherited from Base

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

Constructor Details

Instance Method Details

#deregistration_delay_timeout ⇒ Object?

#health_check_interval ⇒ Object?

#health_check_path ⇒ String?

#health_check_port ⇒ String?

#health_check_protocol ⇒ :http, ...

#health_check_timeout ⇒ Object?

#healthy_threshold_count ⇒ Object?

#modify_targets ⇒ Boolean?

#name ⇒ String

#port ⇒ Integer?

#protocol ⇒ :http, ...

#purge_tags ⇒ Boolean?

#state ⇒ :present, :absent

#stickiness_enabled ⇒ Symbol?

#stickiness_lb_cookie_duration ⇒ Object?

#stickiness_type ⇒ String?

#successful_response_codes ⇒ Array<Integer>, ...

#tags ⇒ Object?

#target_type ⇒ :instance, ...

#targets ⇒ Array<Hash>, ...

#unhealthy_threshold_count ⇒ Object?

#vpc_id ⇒ String?

#wait ⇒ Symbol?

#wait_timeout ⇒ Integer?

#deregistration_delay_timeout ⇒ `Object`^?

#health_check_interval ⇒ `Object`^?

#health_check_path ⇒ `String`^?

#health_check_port ⇒ `String`^?

#health_check_protocol ⇒ `:http`, ...

#health_check_timeout ⇒ `Object`^?

#healthy_threshold_count ⇒ `Object`^?

#modify_targets ⇒ `Boolean`^?

#name ⇒ `String`

#port ⇒ `Integer`^?

#protocol ⇒ `:http`, ...

#purge_tags ⇒ `Boolean`^?

#state ⇒ `:present`, `:absent`

#stickiness_enabled ⇒ `Symbol`^?

#stickiness_lb_cookie_duration ⇒ `Object`^?

#stickiness_type ⇒ `String`^?

#successful_response_codes ⇒ `Array<Integer>`, ...

#tags ⇒ `Object`^?

#target_type ⇒ `:instance`, ...

#targets ⇒ `Array<Hash>`, ...

#unhealthy_threshold_count ⇒ `Object`^?

#vpc_id ⇒ `String`^?

#wait ⇒ `Symbol`^?

#wait_timeout ⇒ `Integer`^?