community.aws.elb_target_group_info module – Gather information about ELB target groups in AWS
Note
This module is part of the community.aws collection (version 5.5.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.elb_target_group_info
.
New in community.aws 1.0.0
Synopsis
Gather information about ELB target groups in AWS
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
When set to Choices:
|
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The Amazon Resource Name (ARN) of the load balancer. |
|
The names of the target groups. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The Amazon Resource Names (ARN) of the target groups. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all target groups
community.aws.elb_target_group_info:
- name: Gather information about the target group attached to a particular ELB
community.aws.elb_target_group_info:
load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/aabbccddeeff"
- name: Gather information about a target groups named 'tg1' and 'tg2'
community.aws.elb_target_group_info:
names:
- tg1
- tg2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
a list of target groups Returned: always |
|
The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. Returned: always Sample: |
|
The approximate amount of time, in seconds, between health checks of an individual target. Returned: always Sample: |
|
The destination for the health check request. Returned: always Sample: |
|
The port to use to connect with the target. Returned: always Sample: |
|
The protocol to use to connect with the target. Returned: always Sample: |
|
The amount of time, in seconds, during which no response means a failed health check. Returned: always Sample: |
|
The number of consecutive health checks successes required before considering an unhealthy target healthy. Returned: always Sample: |
|
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group. Returned: always Sample: |
|
The HTTP codes to use when checking for a successful response from a target. Returned: always Sample: |
|
The port on which the targets are listening. Returned: always Sample: |
|
The protocol to use for routing traffic to the targets. Returned: always Sample: |
|
Indicates whether sticky sessions are enabled. Returned: always Sample: |
|
Indicates whether sticky sessions are enabled. Returned: always Sample: |
|
The type of sticky sessions. Returned: always Sample: |
|
The tags attached to the target group. Returned: always Sample: |
|
The Amazon Resource Name (ARN) of the target group. Returned: always Sample: |
|
The name of the target group. Returned: always Sample: |
|
Targets health description. Returned: when collect_targets_health is enabled |
|
The port to check target health. Returned: always Sample: |
|
The target metadata. Returned: always |
|
The ID of the target. Returned: always Sample: |
|
The port to use to connect with the target. Returned: always Sample: |
|
The target health status. Returned: always |
|
The state of the target health. Returned: always Sample: |
|
The number of consecutive health check failures required before considering the target unhealthy. Returned: always Sample: |
|
The ID of the VPC for the targets. Returned: always Sample: |