community.aws.elb_target_group module – Manage a target group for an Application or Network load balancer
Note
This module is part of the community.aws collection (version 2.6.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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
Synopsis
Manage an AWS Elastic Load Balancer target group. See https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html or https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html for details.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.15.0
botocore >= 1.18.0
Parameters
Parameter |
Comments |
|---|---|
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. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. 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. |
|
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. |
|
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. Choices:
|
|
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. |
|
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. |
|
The approximate amount of time, in seconds, between health checks of an individual target. |
|
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. |
|
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. |
|
The protocol the load balancer uses when performing health checks on targets. Choices:
|
|
The amount of time, in seconds, during which no response from a target means a failed health check. |
|
The number of consecutive health checks successes required before considering an unhealthy target healthy. |
|
Whether or not to alter existing targets in the group to match what is passed with the module Choices:
|
|
The name of the target group. |
|
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 |
|
Indicates whether client IP preservation is enabled. The default is disabled if the target group type is preserve_client_ip_enabled is supported only by Network Load Balancers. Choices:
|
|
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. |
|
The protocol to use for routing traffic to the targets. Required when state is Choices:
|
|
Indicates whether Proxy Protocol version 2 is enabled. The value is proxy_protocol_v2_enabled is supported only by Network Load Balancers. Choices:
|
|
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. Choices:
|
|
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 |
|
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. |
|
Create or destroy the target group. Choices:
|
|
The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). |
|
The name of the application cookie. Required if stickiness_type=app_cookie. |
|
Indicates whether sticky sessions are enabled. Choices:
|
|
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). |
|
The type of sticky sessions. Valid values are If not set AWS will default to |
|
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. |
|
A dictionary of one or more tags to assign to the target group. |
|
The type of target that you must specify when registering targets with this target group. The possible values are The default behavior is Choices:
|
|
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. |
|
The number of consecutive health check failures required before considering a target unhealthy. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
The identifier of the virtual private cloud (VPC). Required when state is |
|
Whether or not to wait for the target group. Choices:
|
|
The time to wait for the target group. Default: 200 |
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_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLEWhen no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
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 |
Description |
|---|---|
The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. Returned: when state present Sample: 300 |
|
The approximate amount of time, in seconds, between health checks of an individual target. Returned: when state present Sample: 30 |
|
The destination for the health check request. Returned: when state present Sample: “/index.html” |
|
The port to use to connect with the target. Returned: when state present Sample: “traffic-port” |
|
The protocol to use to connect with the target. Returned: when state present Sample: “HTTP” |
|
The amount of time, in seconds, during which no response means a failed health check. Returned: when state present Sample: 5 |
|
The number of consecutive health checks successes required before considering an unhealthy target healthy. Returned: when state present Sample: 5 |
|
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group. Returned: when state present Sample: [] |
|
The HTTP codes to use when checking for a successful response from a target. Returned: when state present Sample: {“http_code”: “200”} |
|
The port on which the targets are listening. Returned: when state present Sample: 80 |
|
The protocol to use for routing traffic to the targets. Returned: when state present Sample: “HTTP” |
|
Indicates whether sticky sessions are enabled. Returned: when state present Sample: true |
|
The time period, in seconds, during which requests from a client should be routed to the same target. Returned: when state present Sample: 86400 |
|
The type of sticky sessions. Returned: when state present Sample: “lb_cookie” |
|
The tags attached to the target group. Returned: when state present Sample: “{ \u0027Tag\u0027: \u0027Example\u0027 }” |
|
The Amazon Resource Name (ARN) of the target group. Returned: when state present Sample: “arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211” |
|
The name of the target group. Returned: when state present Sample: “mytargetgroup” |
|
The number of consecutive health check failures required before considering the target unhealthy. Returned: when state present Sample: 2 |
|
The ID of the VPC for the targets. Returned: when state present Sample: “vpc-0123456” |
Authors
Rob White (@wimnat)