Docs4dev
Docs
ansible / latest / collections / community / aws / ec2_lc_info_module.html

community.aws.ec2_lc_info – Gather information about AWS Autoscaling Launch Configurations.

Note

This plugin is part of the community.aws collection (version 1.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.

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

New in version 1.0.0: of community.aws

Synopsis

  • Gather information about AWS Autoscaling Launch Configurations.
  • This module was called ec2_lc_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
name
list / elements=string
Default:
[]
A name or a list of name to match.
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
sort
string
    Choices:
  • launch_configuration_name
  • image_id
  • created_time
  • instance_type
  • kernel_id
  • ramdisk_id
  • key_name
Optional attribute which with to sort the results.
sort_end
integer
Which result to end with (when sorting).
Corresponds to Python slice notation.
sort_order
string
    Choices:
  • ascending ←
  • descending
Order in which to sort results.
Only used when the 'sort' parameter is specified.
sort_start
integer
Which result to start with (when sorting).
Corresponds to Python slice notation.
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 launch configurations
  community.aws.ec2_lc_info:

- name: Gather information about launch configuration with name "example"
  community.aws.ec2_lc_info:
    name: example

- name: Gather information sorted by created_time from most recent to least recent
  community.aws.ec2_lc_info:
    sort: created_time
    sort_order: descending

Return Values

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

Key Returned Description
block_device_mapping
list / elements=string
always
Block device mapping for the instances of launch configuration

Sample:
[{ 'device_name': '/dev/xvda':, 'ebs': { 'delete_on_termination': true, 'volume_size': 8, 'volume_type': 'gp2' }]
classic_link_vpc_security_groups
string
always
IDs of one or more security groups for the VPC specified in classic_link_vpc_id

created_time
string
always
The creation date and time for the launch configuration

Sample:
2016-05-27T13:47:44.216000+00:00
ebs_optimized
boolean
always
EBS I/O optimized (true ) or not (false )

Sample:
true,
image_id
string
always
ID of the Amazon Machine Image (AMI)

Sample:
ami-12345678
instance_monitoring
dictionary
always
Launched with detailed monitoring or not

Sample:
{ 'enabled': true }
instance_type
string
always
Instance type

Sample:
t2.micro
kernel_id
string
always
ID of the kernel associated with the AMI

key_name
string
always
Name of the key pair

Sample:
user_app
launch_configuration_arn
string
always
Amazon Resource Name (ARN) of the launch configuration

Sample:
arn:aws:autoscaling:us-east-1:666612345678:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app
launch_configuration_name
string
always
Name of the launch configuration

Sample:
lc-app
ramdisk_id
string
always
ID of the RAM disk associated with the AMI

security_groups
list / elements=string
always
Security groups to associated

Sample:
[ 'web' ]
user_data
string
always
User data available



Authors

  • Loïc Latreille (@psykotox)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ec2_lc_info_module.html