community.aws.ec2_lc_find – Find AWS Autoscaling Launch Configurations

From Get docs
Ansible/docs/2.11/collections/community/aws/ec2 lc find module


community.aws.ec2_lc_find – Find AWS Autoscaling Launch Configurations

Note

This plugin is part of the community.aws collection (version 1.3.0).

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

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


New in version 1.0.0: of community.aws


Synopsis

  • Returns list of matching Launch Configurations for a given name, along with other useful information.
  • Results can be sorted and sliced.
  • It depends on boto.
  • Based on the work by Tom Bamford https://github.com/tombamford

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

  • 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

limit

integer

How many results to show.

Corresponds to Python slice notation like list[:limit].

name_regex

string / required

A Launch Configuration to match.

It'll be compiled as regex.

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_order

string

  • ascending

  • descending

Order in which to sort results.

validate_certs

boolean

  • 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: Search for the Launch Configurations that start with "app"
  community.aws.ec2_lc_find:
    name_regex: app.*
    sort_order: descending
    limit: 2

Return Values

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

Key Returned Description

arn

string

when Launch Configuration was found

Name of the AMI


Sample:

arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject

associate_public_address

boolean

when Launch Configuration was found

Assign public address or not


Sample:

True

block_device_mappings

list / elements=string

when Launch Configuration was found

Launch Configuration block device mappings property


classic_link_vpc_security_groups

list / elements=string

when Launch Configuration was found

Launch Configuration classic link vpc security groups property


created_time

string

when Launch Configuration was found

When it was created


Sample:

2016-06-29T14:59:22.222000+00:00

ebs_optimized

boolean

when Launch Configuration was found

Launch Configuration EBS optimized property


image_id

string

when Launch Configuration was found

AMI id


Sample:

ami-0d75df7e

instance_monitoring

string

when Launch Configuration was found

Launch Configuration instance monitoring property


Sample:

{'Enabled': False}

instance_type

string

when Launch Configuration was found

Type of ec2 instance


Sample:

t2.small

kernel_id

string

when Launch Configuration was found

Launch Configuration kernel to use


keyname

string

when Launch Configuration was found

Launch Configuration ssh key


Sample:

mykey

name

string

when Launch Configuration was found

Name of the Launch Configuration


Sample:

myapp-v123

ram_disk_id

string

when Launch Configuration was found

Launch Configuration ram disk property


security_groups

list / elements=string

when Launch Configuration was found

Launch Configuration security groups


user_data

string

when Launch Configuration was found

User data used to start instance


Sample:

ZXhwb3J0IENMT1VE




Authors

  • Jose Armesto (@fiunchinho)

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