Try SpotterManage a target group for an Application or Network load balancer
| "added in version" 1.0.0 of community.aws"
Authors: Rob White (@wimnat)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Manage an AWS Elastic Load Balancer target group. See U(https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) or U(https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html) for details.
# 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: Create a target group with protocol_version 'GRPC'
community.aws.elb_target_group:
name: mytargetgroup
protocol: http
port: 80
vpc_id: vpc-01234567
protocol_version: GRPC
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
name:
description:
- The name of the target group.
required: true
type: str
port:
description:
- The port on which the targets receive traffic. This port is used unless you specify
a port override when registering the target.
- Required when I(state) is C(present) and I(target_type) is C(instance), C(ip), or
C(alb).
required: false
type: int
tags:
aliases:
- resource_tags
description:
- A dictionary representing the tags to be applied to the resource.
- If the I(tags) parameter is not set then tags will not be modified.
required: false
type: dict
wait:
default: false
description:
- Whether or not to wait for the target group.
type: bool
state:
choices:
- present
- absent
description:
- Create or destroy the target group.
required: true
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
vpc_id:
description:
- The identifier of the virtual private cloud (VPC).
- Required when I(state) is C(present) and I(target_type) is C(instance), C(ip), or
C(alb).
required: false
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
targets:
description:
- 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.
elements: dict
required: false
type: list
protocol:
choices:
- http
- https
- tcp
- tls
- udp
- tcp_udp
- HTTP
- HTTPS
- TCP
- TLS
- UDP
- TCP_UDP
description:
- The protocol to use for routing traffic to the targets.
- Required when I(state) is C(present) and I(target_type) is C(instance), C(ip), or
C(alb).
required: false
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
default: true
description:
- If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the
resource to match exactly what is defined by I(tags) parameter.
- If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True).
- Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As
such they will be ignored for the purposes of the I(purge_tags) parameter. See
the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions).
required: false
type: bool
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
target_type:
choices:
- instance
- ip
- lambda
- alb
description:
- 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),
C(ip) (targets are specified by IP address), C(lambda) (target is specified by ARN),
or C(alb) (target is specified by ARN). Note that you can't specify targets for
a target group using more than one type. Target types lambda and alb 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 C(instance).
required: false
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
wait_timeout:
default: 200
description:
- The time to wait for the target group.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
modify_targets:
default: true
description:
- Whether or not to alter existing targets in the group to match what is passed with
the module
required: false
type: bool
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
stickiness_type:
description:
- The type of sticky sessions.
- Valid values are C(lb_cookie), C(app_cookie) or C(source_ip).
- If not set AWS will default to C(lb_cookie) for Application Load Balancers or C(source_ip)
for Network Load Balancers.
type: str
protocol_version:
choices:
- GRPC
- HTTP1
- HTTP2
description:
- Specifies protocol version.
- The protocol_version parameter is immutable and cannot be changed when updating
an elb_target_group.
required: false
type: str
version_added: 5.1.0
version_added_collection: community.aws
health_check_path:
description:
- 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 I(health_check_protocol) parameter to be set.
required: false
type: str
health_check_port:
description:
- 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.
required: false
type: str
stickiness_enabled:
description:
- Indicates whether sticky sessions are enabled.
type: bool
health_check_timeout:
description:
- The amount of time, in seconds, during which no response from a target means a failed
health check.
required: false
type: int
health_check_interval:
description:
- The approximate amount of time, in seconds, between health checks of an individual
target.
required: false
type: int
health_check_protocol:
choices:
- http
- https
- tcp
- tls
- udp
- tcp_udp
- HTTP
- HTTPS
- TCP
- TLS
- UDP
- TCP_UDP
description:
- The protocol the load balancer uses when performing health checks on targets.
required: false
type: str
healthy_threshold_count:
description:
- The number of consecutive health checks successes required before considering an
unhealthy target healthy.
required: false
type: int
proxy_protocol_v2_enabled:
description:
- Indicates whether Proxy Protocol version 2 is enabled.
- The value is C(true) or C(false).
- I(proxy_protocol_v2_enabled) is supported only by Network Load Balancers.
required: false
type: bool
version_added: 2.1.0
version_added_collection: community.aws
successful_response_codes:
description:
- 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 I(health_check_protocol) parameter to be set.
required: false
type: str
unhealthy_threshold_count:
description:
- The number of consecutive health check failures required before considering a target
unhealthy.
required: false
type: int
preserve_client_ip_enabled:
description:
- Indicates whether client IP preservation is enabled.
- The default is disabled if the target group type is C(ip) address and the target
group protocol is C(tcp) or C(tls). Otherwise, the default is enabled. Client IP
preservation cannot be disabled for C(udp) and C(tcp_udp) target groups.
- I(preserve_client_ip_enabled) is supported only by Network Load Balancers.
required: false
type: bool
version_added: 2.1.0
version_added_collection: community.aws
stickiness_app_cookie_name:
description:
- The name of the application cookie. Required if I(stickiness_type=app_cookie).
type: str
version_added: 1.5.0
version_added_collection: community.aws
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
deregistration_delay_timeout:
description:
- 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.
type: int
load_balancing_algorithm_type:
choices:
- round_robin
- least_outstanding_requests
description:
- The type of load balancing algorithm to use.
- Changing the load balancing algorithm is only supported when used with Application
Load Balancers (ALB).
- If not set AWS will default to C(round_robin).
type: str
version_added: 3.2.0
version_added_collection: community.aws
stickiness_lb_cookie_duration:
description:
- 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).
type: int
stickiness_app_cookie_duration:
description:
- 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).
type: int
version_added: 1.5.0
version_added_collection: community.aws
deregistration_connection_termination:
default: false
description:
- Indicates whether the load balancer terminates connections at the end of the deregistration
timeout.
- Using this option is only supported when attaching to a Network Load Balancer (NLB).
required: false
type: bool
version_added: 3.1.0
version_added_collection: community.aws
deregistration_connection_termination:
description: Indicates whether the load balancer terminates connections at the end
of the deregistration timeout.
returned: when state present
sample: true
type: bool
deregistration_delay_timeout_seconds:
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
type: int
health_check_interval_seconds:
description: The approximate amount of time, in seconds, between health checks of
an individual target.
returned: when state present
sample: 30
type: int
health_check_path:
description: The destination for the health check request.
returned: when state present
sample: /index.html
type: str
health_check_port:
description: The port to use to connect with the target.
returned: when state present
sample: traffic-port
type: str
health_check_protocol:
description: The protocol to use to connect with the target.
returned: when state present
sample: HTTP
type: str
health_check_timeout_seconds:
description: The amount of time, in seconds, during which no response means a failed
health check.
returned: when state present
sample: 5
type: int
healthy_threshold_count:
description: The number of consecutive health checks successes required before considering
an unhealthy target healthy.
returned: when state present
sample: 5
type: int
load_balancer_arns:
description: The Amazon Resource Names (ARN) of the load balancers that route traffic
to this target group.
returned: when state present
sample: []
type: list
load_balancing_algorithm_type:
description: The type load balancing algorithm used.
returned: when state present
sample: least_outstanding_requests
type: str
version_added: 3.2.0
version_added_collection: community.aws
matcher:
description: The HTTP codes to use when checking for a successful response from
a target.
returned: when state present
sample:
http_code: '200'
type: dict
port:
description: The port on which the targets are listening.
returned: when state present
sample: 80
type: int
protocol:
description: The protocol to use for routing traffic to the targets.
returned: when state present
sample: HTTP
type: str
stickiness_enabled:
description: Indicates whether sticky sessions are enabled.
returned: when state present
sample: true
type: bool
stickiness_lb_cookie_duration_seconds:
description: The time period, in seconds, during which requests from a client should
be routed to the same target.
returned: when state present
sample: 86400
type: int
stickiness_type:
description: The type of sticky sessions.
returned: when state present
sample: lb_cookie
type: str
tags:
description: The tags attached to the target group.
returned: when state present
sample: '{ ''Tag'': ''Example'' }'
type: dict
target_group_arn:
description: The Amazon Resource Name (ARN) of the target group.
returned: when state present
sample: arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/mytargetgroup/aabbccddee0044332211
type: str
target_group_name:
description: The name of the target group.
returned: when state present
sample: mytargetgroup
type: str
unhealthy_threshold_count:
description: The number of consecutive health check failures required before considering
the target unhealthy.
returned: when state present
sample: 2
type: int
vpc_id:
description: The ID of the VPC for the targets.
returned: when state present
sample: vpc-0123456
type: str