Try SpotterManage a target group for an Application load balancer
| "added in version" 2.4 of ansible.builtin"
Authors: Rob White (@wimnat)
preview | supported by community
pipInstall with pip install ansible==2.4.3.0.post1
Manage an AWS Application Elastic Load Balancer target group. See U(http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) for details.
# 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 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
name:
description:
- The name of the target group.
required: true
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 if I(state) is C(present).
required: false
tags:
description:
- A dictionary of one or more tags to assign to the target group.
required: false
state:
choices:
- present
- absent
description:
- Create or destroy the target group.
required: true
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
vpc_id:
description:
- The identifier of the virtual private cloud (VPC). Required when I(state) is C(present).
required: false
profile:
aliases:
- aws_profile
description:
- 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.
required: false
protocol:
choices:
- http
- https
description:
- The protocol to use for routing traffic to the targets. Required when I(state) is
C(present).
required: false
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
choices:
- 'yes'
- 'no'
default: true
description:
- 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.
required: false
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- The I(aws_secret_key) and I(profile) options are mutually exclusive.
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
security_token:
aliases:
- aws_session_token
- session_token
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
stickiness_type:
default: lb_cookie
description:
- The type of sticky sessions. The possible value is lb_cookie.
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.
required: false
health_check_port:
default: The port on which each target receives traffic from the load balancer.
description:
- The port the load balancer uses when performing health checks on targets.
required: false
stickiness_enabled:
choices:
- 'yes'
- 'no'
description:
- Indicates whether sticky sessions are enabled.
health_check_timeout:
description:
- The amount of time, in seconds, during which no response from a target means a failed
health check.
required: false
health_check_interval:
description:
- The approximate amount of time, in seconds, between health checks of an individual
target.
required: false
health_check_protocol:
choices:
- http
- https
description:
- The protocol the load balancer uses when performing health checks on targets.
required: false
healthy_threshold_count:
description:
- The number of consecutive health checks successes required before considering an
unhealthy target healthy.
required: false
successful_response_codes:
description:
- '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").
'
required: false
unhealthy_threshold_count:
description:
- The number of consecutive health check failures required before considering a target
unhealthy.
required: false
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
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.
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).
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: string
health_check_port:
description: The port to use to connect with the target.
returned: when state present
sample: traffic-port
type: string
health_check_protocol:
description: The protocol to use to connect with the target.
returned: when state present
sample: HTTP
type: string
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
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: string
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: string
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:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211
type: string
target_group_name:
description: The name of the target group.
returned: when state present
sample: mytargetgroup
type: string
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: string