community / community.aws / 0.1.2 / module / elb_target_group_info Gather information about ELB target groups in AWS | "added in version" 1.0.0 of community.aws" Authors: Rob White (@wimnat)community.aws.elb_target_group_info (0.1.2) — module
Install with ansible-galaxy collection install community.aws:==0.1.2
collections: - name: community.aws version: 0.1.2
Gather information about ELB target groups in AWS
This module was called C(elb_target_group_facts) before Ansible 2.9. The usage did not change.
# 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:001122334455: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
names: description: - The names of the target groups. required: false type: list 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 ec2_url: aliases: - aws_endpoint_url - endpoint_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 profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str 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). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - 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.' 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - 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. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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 load_balancer_arn: description: - The Amazon Resource Name (ARN) of the load balancer. required: false type: str target_group_arns: description: - The Amazon Resource Names (ARN) of the target groups. required: false type: list collect_targets_health: default: false description: - When set to "yes", output contains targets health description required: false type: bool 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
target_groups: contains: 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: always sample: 300 type: int health_check_interval_seconds: description: The approximate amount of time, in seconds, between health checks of an individual target. returned: always sample: 30 type: int health_check_path: description: The destination for the health check request. returned: always sample: /index.html type: str health_check_port: description: The port to use to connect with the target. returned: always sample: traffic-port type: str health_check_protocol: description: The protocol to use to connect with the target. returned: always 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: always sample: 5 type: int healthy_threshold_count: description: The number of consecutive health checks successes required before considering an unhealthy target healthy. returned: always 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: always sample: [] type: list matcher: description: The HTTP codes to use when checking for a successful response from a target. returned: always sample: http_code: '200' type: dict port: description: The port on which the targets are listening. returned: always sample: 80 type: int protocol: description: The protocol to use for routing traffic to the targets. returned: always sample: HTTP type: str stickiness_enabled: description: Indicates whether sticky sessions are enabled. returned: always sample: true type: bool stickiness_lb_cookie_duration_seconds: description: Indicates whether sticky sessions are enabled. returned: always sample: 86400 type: int stickiness_type: description: The type of sticky sessions. returned: always sample: lb_cookie type: str tags: description: The tags attached to the target group. returned: always sample: '{ ''Tag'': ''Example'' }' type: dict target_group_arn: description: The Amazon Resource Name (ARN) of the target group. returned: always sample: arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211 type: str target_group_name: description: The name of the target group. returned: always sample: mytargetgroup type: str targets_health_description: contains: health_check_port: description: The port to check target health. returned: always sample: '80' type: str target: contains: id: description: The ID of the target. returned: always sample: i-0123456789 type: str port: description: The port to use to connect with the target. returned: always sample: 80 type: int description: The target metadata. returned: always type: complex target_health: contains: state: description: The state of the target health. returned: always sample: healthy type: str description: The target health status. returned: always type: complex description: Targets health description. returned: when collect_targets_health is enabled type: complex unhealthy_threshold_count: description: The number of consecutive health check failures required before considering the target unhealthy. returned: always sample: 2 type: int vpc_id: description: The ID of the VPC for the targets. returned: always sample: vpc-0123456 type: str description: a list of target groups returned: always type: complex