community.aws.elb_application_lb_info – Gather information about application ELBs in AWS

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.elb_application_lb_info.

New in version 1.0.0: of community.aws

Synopsis

  • Gather information about application ELBs in AWS

  • This module was called elb_application_lb_facts before Ansible 2.9. The usage did not change.

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
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 profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
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.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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 profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
load_balancer_arns
list / elements=string
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
names
list / elements=string
The names of the load balancers.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

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_application_lb_info:

- name: Gather information about the target group attached to a particular ELB
  community.aws.elb_application_lb_info:
    load_balancer_arns:
      - "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_application_lb_info:
    names:
      - elb1
      - elb2

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
load_balancers
complex
always
a list of load balancers

 
access_logs_s3_bucket
string
when status is present
The name of the S3 bucket for the access logs.

Sample:
mys3bucket
 
access_logs_s3_enabled
string
when status is present
Indicates whether access logs stored in Amazon S3 are enabled.

Sample:
True
 
access_logs_s3_prefix
string
when status is present
The prefix for the location in the S3 bucket.

Sample:
/my/logs
 
availability_zones
list / elements=string
when status is present
The Availability Zones for the load balancer.

Sample:
[{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a'}]
 
canonical_hosted_zone_id
string
when status is present
The ID of the Amazon Route 53 hosted zone associated with the load balancer.

Sample:
ABCDEF12345678
 
created_time
string
when status is present
The date and time the load balancer was created.

Sample:
2015-02-12T02:14:02+00:00
 
deletion_protection_enabled
string
when status is present
Indicates whether deletion protection is enabled.

Sample:
True
 
dns_name
string
when status is present
The public DNS name of the load balancer.

Sample:
internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
 
idle_timeout_timeout_seconds
string
when status is present
The idle timeout value, in seconds.

Sample:
60
 
ip_address_type
string
when status is present
The type of IP addresses used by the subnets for the load balancer.

Sample:
ipv4
 
load_balancer_arn
string
when status is present
The Amazon Resource Name (ARN) of the load balancer.

Sample:
arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
 
load_balancer_name
string
when status is present
The name of the load balancer.

Sample:
my-elb
 
scheme
string
when status is present
Internet-facing or internal load balancer.

Sample:
internal
 
security_groups
list / elements=string
when status is present
The IDs of the security groups for the load balancer.

Sample:
['sg-0011223344']
 
state
dictionary
when status is present
The state of the load balancer.

Sample:
{'code': 'active'}
 
tags
dictionary
when status is present
The tags attached to the load balancer.

Sample:
{ 'Tag': 'Example' }
 
type
string
when status is present
The type of load balancer.

Sample:
application
 
vpc_id
string
when status is present
The ID of the VPC for the load balancer.

Sample:
vpc-0011223344


Authors

  • Rob White (@wimnat)