W3cubDocs

/Ansible

ec2_lc_facts - Gather facts about AWS Autoscaling Launch Configurations

New in version 2.3.

Synopsis

  • Gather facts about AWS Autoscaling Launch Configurations

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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.
aliases: ec2_access_key, access_key
aws_secret_key
 no
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.
aliases: ec2_secret_key, secret_key
ec2_url
 no
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.
name
 no
A name or a list of name to match.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
region
 no
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
(added in 1.6)
 no
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
sort
 no
  • 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
 no
Which result to end with (when sorting).
Corresponds to Python slice notation.
sort_order
 no ascending
  • ascending
  • descending
Order in which to sort results.
Only used when the 'sort' parameter is specified.
sort_start
 no
Which result to start with (when sorting).
Corresponds to Python slice notation.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather facts about all launch configurations
- ec2_lc_facts:

# Gather facts about launch configuration with name "example"
- ec2_lc_facts:
    name: example

# Gather facts sorted by created_time from most recent to least recent
- ec2_lc_facts:
    sort: created_time
    sort_order: descending

Return Values

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

name description returned type sample
ramdisk_id
ID of the RAM disk associated with the AMI
 always string None
block_device_mapping
Block device mapping for the instances of launch configuration
 always list [{ 'device_name': '/dev/xvda':, 'ebs': { 'delete_on_termination': true, 'volume_size': 8, 'volume_type': 'gp2' }]
kernel_id
ID of the kernel associated with the AMI
 always string None
key_name
Name of the key pair
 always string user_app
launch_configuration_name
Name of the launch configuration
 always string lc-app
ebs_optimized
EBS I/O optimized (true ) or not (false )
 always bool true,
user_data
User data available
 always string None
image_id
ID of the Amazon Machine Image (AMI)
 always string ami-12345678
instance_type
Instance type
 always string t2.micro
created_time
The creation date and time for the launch configuration
 always string 2016-05-27T13:47:44.216000+00:00
instance_monitoring
Launched with detailed monitoring or not
 always dict { 'enabled': true }
launch_configuration_arn
Amazon Resource Name (ARN) of the launch configuration
 always string arn:aws:autoscaling:us-east-1:666612345678:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app
security_groups
Security groups to associated
 always list [ 'web' ]
classic_link_vpc_security_groups
IDs of one or more security groups for the VPC specified in classic_link_vpc_id
 always string None

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_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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ec2_lc_facts_module.html