Documentation

elb_target_group - Manage a target group for an Application or Network load balancer

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter
Choices/Defaults
Comments
aws_access_key
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
deregistration_delay_timeout
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.
ec2_url
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
health_check_interval
The approximate amount of time, in seconds, between health checks of an individual target.
health_check_path
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.
health_check_port
Default:
The port on which each target receives traffic from the load balancer.
The port the load balancer uses when performing health checks on targets. Can be set to 'traffic-port' to match target port.
health_check_protocol
    Choices:
  • http
  • https
  • tcp
The protocol the load balancer uses when performing health checks on targets.
health_check_timeout
The amount of time, in seconds, during which no response from a target means a failed health check.
healthy_threshold_count
The number of consecutive health checks successes required before considering an unhealthy target healthy.
modify_targets
Default:
yes
Whether or not to alter existing targets in the group to match what is passed with the module
name
required
The name of the target group.
port
The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if state is present.
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
protocol
    Choices:
  • http
  • https
  • tcp
The protocol to use for routing traffic to the targets. Required when state is present.
purge_tags
    Choices:
  • no
  • yes ←
If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tag parameter is not set then tags will not be modified.
region
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
(added in 1.6)
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
state
required
    Choices:
  • present
  • absent
Create or destroy the target group.
stickiness_enabled
    Choices:
  • no
  • yes
Indicates whether sticky sessions are enabled.
stickiness_lb_cookie_duration
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).
stickiness_type
Default:
lb_cookie
The type of sticky sessions. The possible value is lb_cookie.
successful_response_codes
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").
tags
A dictionary of one or more tags to assign to the target group.
target_type
(added in 2.5)
    Choices:
  • instance ←
  • ip
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or 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.
targets
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.
unhealthy_threshold_count
The number of consecutive health check failures required before considering a target unhealthy.
validate_certs
(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_id
The identifier of the virtual private cloud (VPC). Required when state is present.

Notes

Note

  • Once a target group has been created, only its health check can then be modified using subsequent calls
  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Create a target group with a default health check
- elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 80
    vpc_id: vpc-01234567
    state: present

# Modify the target group with a custom health check
- elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 80
    vpc_id: vpc-01234567
    health_check_path: /
    successful_response_codes: "200, 250-260"
    state: present

# Delete a target group
- elb_target_group:
    name: mytargetgroup
    state: absent

# Create a target group with instance targets
- elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 81
    vpc_id: vpc-01234567
    health_check_path: /
    successful_response_codes: "200,250-260"
    targets:
      - Id: i-01234567
        Port: 80
      - Id: i-98765432
        Port: 80
    state: present
    wait_timeout: 200
    wait: True

# Create a target group with IP address targets
- elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 81
    vpc_id: vpc-01234567
    health_check_path: /
    successful_response_codes: "200,250-260"
    target_type: ip
    targets:
      - Id: 10.0.0.10
        Port: 80
        AvailabilityZone: all
      - Id: 10.0.0.20
        Port: 80
    state: present
    wait_timeout: 200
    wait: True

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key
Returned
Description
deregistration_delay_timeout_seconds
int
when state present
The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused.

Sample:
300
health_check_interval_seconds
int
when state present
The approximate amount of time, in seconds, between health checks of an individual target.

Sample:
30
health_check_path
string
when state present
The destination for the health check request.

Sample:
/index.html
health_check_port
string
when state present
The port to use to connect with the target.

Sample:
traffic-port
health_check_protocol
string
when state present
The protocol to use to connect with the target.

Sample:
HTTP
health_check_timeout_seconds
int
when state present
The amount of time, in seconds, during which no response means a failed health check.

Sample:
5
healthy_threshold_count
int
when state present
The number of consecutive health checks successes required before considering an unhealthy target healthy.

Sample:
5
load_balancer_arns
list
when state present
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

matcher
dict
when state present
The HTTP codes to use when checking for a successful response from a target.

Sample:
{'http_code': '200'}
port
int
when state present
The port on which the targets are listening.

Sample:
80
protocol
string
when state present
The protocol to use for routing traffic to the targets.

Sample:
HTTP
stickiness_enabled
bool
when state present
Indicates whether sticky sessions are enabled.

Sample:
True
stickiness_lb_cookie_duration_seconds
int
when state present
The time period, in seconds, during which requests from a client should be routed to the same target.

Sample:
86400
stickiness_type
string
when state present
The type of sticky sessions.

Sample:
lb_cookie
tags
dict
when state present
The tags attached to the target group.

Sample:
{ 'Tag': 'Example' }
target_group_arn
string
when state present
The Amazon Resource Name (ARN) of the target group.

Sample:
arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211
target_group_name
string
when state present
The name of the target group.

Sample:
mytargetgroup
unhealthy_threshold_count
int
when state present
The number of consecutive health check failures required before considering the target unhealthy.

Sample:
2
vpc_id
string
when state present
The ID of the VPC for the targets.

Sample:
vpc-0123456


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rob White (@wimnat)

Hint

If you notice any issues in this documentation you can edit this document to improve it.