Try SpotterGather information about Application Load Balancers in AWS
| "added in version" 1.0.0 of community.aws"
Authors: Rob White (@wimnat)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0Gather information about Application Load Balancers in AWS
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Gather information about all ALBs community.aws.elb_application_lb_info:
- name: Gather information about a particular ALB given its ARN
community.aws.elb_application_lb_info:
load_balancer_arns:
- "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-alb/aabbccddeeff"
- name: Gather information about ALBs named 'alb1' and 'alb2'
community.aws.elb_application_lb_info:
names:
- alb1
- alb2
- name: Gather information about specific ALB
community.aws.elb_application_lb_info:
names: "alb-name"
region: "aws-region"
register: alb_info
- ansible.builtin.debug:
var: alb_info
names:
description:
- The names of the load balancers.
elements: str
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:
- Uses a boto profile. Only works with boto >= 2.24.0.
- 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.
- Only used for boto3 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:
- AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY
or 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:
- AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY,
or 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:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0.
type: bool
load_balancer_arns:
description:
- The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20
load balancers in a single call.
elements: str
required: false
type: list
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
load_balancers:
contains:
access_logs_s3_bucket:
description: The name of the S3 bucket for the access logs.
sample: mys3bucket
type: str
access_logs_s3_enabled:
description: Indicates whether access logs stored in Amazon S3 are enabled.
sample: true
type: bool
access_logs_s3_prefix:
description: The prefix for the location in the S3 bucket.
sample: my/logs
type: str
availability_zones:
description: The Availability Zones for the load balancer.
sample:
- load_balancer_addresses: []
subnet_id: subnet-aabbccddff
zone_name: ap-southeast-2a
type: list
canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone associated with the load
balancer.
sample: ABCDEF12345678
type: str
created_time:
description: The date and time the load balancer was created.
sample: '2015-02-12T02:14:02+00:00'
type: str
deletion_protection_enabled:
description: Indicates whether deletion protection is enabled.
sample: true
type: bool
dns_name:
description: The public DNS name of the load balancer.
sample: internal-my-alb-123456789.ap-southeast-2.elb.amazonaws.com
type: str
idle_timeout_timeout_seconds:
description: The idle timeout value, in seconds.
sample: 60
type: int
ip_address_type:
description: The type of IP addresses used by the subnets for the load balancer.
sample: ipv4
type: str
listeners:
contains:
certificates:
contains:
certificate_arn:
description: The Amazon Resource Name (ARN) of the certificate.
sample: ''
type: str
description: The SSL server certificate.
type: complex
default_actions:
contains:
target_group_arn:
description: The Amazon Resource Name (ARN) of the target group.
sample: ''
type: str
type:
description: The type of action.
sample: ''
type: str
description: The default actions for the listener.
type: str
listener_arn:
description: The Amazon Resource Name (ARN) of the listener.
sample: ''
type: str
load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer.
sample: ''
type: str
port:
description: The port on which the load balancer is listening.
sample: 80
type: int
protocol:
description: The protocol for connections from clients to the load balancer.
sample: HTTPS
type: str
ssl_policy:
description: The security policy that defines which ciphers and protocols
are supported.
sample: ''
type: str
description: Information about the listeners.
type: complex
load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer.
sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-alb/001122334455
type: str
load_balancer_name:
description: The name of the load balancer.
sample: my-alb
type: str
routing_http2_enabled:
description: Indicates whether HTTP/2 is enabled.
sample: true
type: bool
routing_http_desync_mitigation_mode:
description: Determines how the load balancer handles requests that might pose
a security risk to an application.
sample: defensive
type: str
routing_http_drop_invalid_header_fields_enabled:
description: Indicates whether HTTP headers with invalid header fields are removed
by the load balancer (true) or routed to targets (false).
sample: false
type: bool
routing_http_x_amzn_tls_version_and_cipher_suite_enabled:
description: Indicates whether the two headers are added to the client request
before sending it to the target.
sample: false
type: bool
routing_http_xff_client_port_enabled:
description: Indicates whether the X-Forwarded-For header should preserve the
source port that the client used to connect to the load balancer.
sample: false
type: bool
scheme:
description: Internet-facing or internal load balancer.
sample: internal
type: str
security_groups:
description: The IDs of the security groups for the load balancer.
sample:
- sg-0011223344
type: list
state:
description: The state of the load balancer.
sample:
code: active
type: dict
tags:
description: The tags attached to the load balancer.
sample:
Tag: Example
type: dict
type:
description: The type of load balancer.
sample: application
type: str
vpc_id:
description: The ID of the VPC for the load balancer.
sample: vpc-0011223344
type: str
waf_fail_open_enabled:
description: Indicates whether to allow a AWS WAF-enabled load balancer to route
requests to targets if it is unable to forward the request to AWS WAF.
sample: false
type: bool
description: a list of load balancers
returned: always
type: complex