community.aws.elb_target_group – Manage a target group for an Application or Network load balancer

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.elb_target_group.

New in version 1.0.0: of community.aws

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
string
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
deregistration_delay_timeout
integer
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
string
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.

aliases: aws_endpoint_url, endpoint_url
health_check_interval
integer
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. The path must be defined in order to set a health check.
Requires the health_check_protocol parameter to be set.
health_check_port
string
The port the load balancer uses when performing health checks on targets. Can be set to 'traffic-port' to match target port.
When not defined will default to the port on which each target receives traffic from the load balancer.
health_check_protocol
string
    Choices:
  • http
  • https
  • tcp
  • tls
  • udp
  • tcp_udp
  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
The protocol the load balancer uses when performing health checks on targets.
health_check_timeout
integer
The amount of time, in seconds, during which no response from a target means a failed health check.
healthy_threshold_count
integer
The number of consecutive health checks successes required before considering an unhealthy target healthy.
modify_targets
boolean
    Choices:
  • no
  • yes ←
Whether or not to alter existing targets in the group to match what is passed with the module
name
string / required
The name of the target group.
port
integer
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
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
protocol
string
    Choices:
  • http
  • https
  • tcp
  • tls
  • udp
  • tcp_udp
  • HTTP
  • HTTPS
  • TCP
  • TLS
  • UDP
  • TCP_UDP
The protocol to use for routing traffic to the targets. Required when state is present.
purge_tags
boolean
    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
string
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
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string / required
    Choices:
  • present
  • absent
Create or destroy the target group.
stickiness_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether sticky sessions are enabled.
stickiness_lb_cookie_duration
integer
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
string
The type of sticky sessions.
If not set AWS will default to lb_cookie for Application Load Balancers or source_ip for Network Load Balancers.
successful_response_codes
string
The HTTP codes to use when checking for a successful response from a target.
Accepts multiple values (for example, "200,202") or a range of values (for example, "200-299").
Requires the health_check_protocol parameter to be set.
tags
dictionary
A dictionary of one or more tags to assign to the target group.
target_type
string
    Choices:
  • instance
  • ip
  • lambda
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), ip (targets are specified by IP address) or lambda (target is specified by ARN). Note that you can't specify targets for a target group using more than one type. Target type lambda only accept one target. When more than one target is specified, only the first one is used. All additional targets are ignored. 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.
The default behavior is instance.
targets
list / elements=dictionary
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
integer
The number of consecutive health check failures required before considering a target unhealthy.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_id
string
The identifier of the virtual private cloud (VPC). Required when state is present.
wait
boolean
    Choices:
  • no ←
  • yes
Whether or not to wait for the target group.
wait_timeout
integer
Default:
200
The time to wait for the target group.

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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/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.

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

- name: Modify the target group with a custom health check
  community.aws.elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 80
    vpc_id: vpc-01234567
    health_check_protocol: http
    health_check_path: /health_check
    health_check_port: 80
    successful_response_codes: 200
    health_check_interval: 15
    health_check_timeout: 3
    healthy_threshold_count: 4
    unhealthy_threshold_count: 3
    state: present

- name: Delete a target group
  community.aws.elb_target_group:
    name: mytargetgroup
    state: absent

- name: Create a target group with instance targets
  community.aws.elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 81
    vpc_id: vpc-01234567
    health_check_protocol: http
    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

- name: Create a target group with IP address targets
  community.aws.elb_target_group:
    name: mytargetgroup
    protocol: http
    port: 81
    vpc_id: vpc-01234567
    health_check_protocol: http
    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

# Using lambda as targets require that the target group
# itself is allow to invoke the lambda function.
# therefore you need first to create an empty target group
# to receive its arn, second, allow the target group
# to invoke the lambda function and third, add the target
# to the target group
- name: first, create empty target group
  community.aws.elb_target_group:
    name: my-lambda-targetgroup
    target_type: lambda
    state: present
    modify_targets: False
  register: out

- name: second, allow invoke of the lambda
  community.aws.lambda_policy:
    state: "{{ state | default('present') }}"
    function_name: my-lambda-function
    statement_id: someID
    action: lambda:InvokeFunction
    principal: elasticloadbalancing.amazonaws.com
    source_arn: "{{ out.target_group_arn }}"

- name: third, add target
  community.aws.elb_target_group:
    name: my-lambda-targetgroup
    target_type: lambda
    state: present
    targets:
        - Id: arn:aws:lambda:eu-central-1:123456789012:function:my-lambda-function

Return Values

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

Key Returned Description
deregistration_delay_timeout_seconds
integer
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
integer
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
integer
when state present
The amount of time, in seconds, during which no response means a failed health check.

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

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

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

Sample:
{'http_code': '200'}
port
integer
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
boolean
when state present
Indicates whether sticky sessions are enabled.

Sample:
True
stickiness_lb_cookie_duration_seconds
integer
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
dictionary
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
integer
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


Authors

  • Rob White (@wimnat)