community / community.aws / 5.1.0 / 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 (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Gather information about ELB target groups in AWS
# 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
names: description: - The names of the target groups. elements: str required: false type: list 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 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 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 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 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 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 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 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. elements: str required: false type: list collect_targets_health: default: false description: - When set to C(True), output contains targets health description required: false type: bool 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
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:123456789012: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