community.aws.ec2_lc_find module – Find AWS Autoscaling Launch Configurations

Note

This module is part of the community.aws collection (version 3.6.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in community.aws 1.0.0

Synopsis

  • Returns list of matching Launch Configurations for a given name, along with other useful information.

  • Results can be sorted and sliced.

  • Based on the work by Tom Bamford https://github.com/tombamford

Requirements

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

  • python >= 3.6

  • boto3 >= 1.16.0

  • botocore >= 1.19.0

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, 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.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Not used by boto 2 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.

Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

aliases: ec2_secret_key, 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.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

ec2_url

aliases: aws_endpoint_url, endpoint_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.

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

aliases: aws_profile

string

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.

region

aliases: aws_region, ec2_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

security_token

aliases: aws_session_token, session_token, aws_security_token, access_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_session_token and session_token have been added in version 3.2.0.

sort_order

string

Order in which to sort results.

Choices:

  • "ascending" ← (default)

  • "descending"

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for communication with the AWS APIs.

Choices:

  • false

  • true ← (default)

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

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

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

Description

arn

string

Name of the AMI

Returned: when Launch Configuration was found

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

associate_public_address

boolean

Assign public address or not

Returned: when Launch Configuration was found

Sample: true

block_device_mappings

list / elements=string

Launch Configuration block device mappings property

Returned: when Launch Configuration was found

Sample: []

list / elements=string

Launch Configuration classic link vpc security groups property

Returned: when Launch Configuration was found

Sample: []

created_time

string

When it was created

Returned: when Launch Configuration was found

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

ebs_optimized

boolean

Launch Configuration EBS optimized property

Returned: when Launch Configuration was found

Sample: false

image_id

string

AMI id

Returned: when Launch Configuration was found

Sample: "ami-0d75df7e"

instance_monitoring

string

Launch Configuration instance monitoring property

Returned: when Launch Configuration was found

Sample: "{'Enabled': False}"

instance_type

string

Type of ec2 instance

Returned: when Launch Configuration was found

Sample: "t2.small"

kernel_id

string

Launch Configuration kernel to use

Returned: when Launch Configuration was found

Sample: ""

keyname

string

Launch Configuration ssh key

Returned: when Launch Configuration was found

Sample: "mykey"

name

string

Name of the Launch Configuration

Returned: when Launch Configuration was found

Sample: "myapp-v123"

ram_disk_id

string

Launch Configuration ram disk property

Returned: when Launch Configuration was found

Sample: ""

security_groups

list / elements=string

Launch Configuration security groups

Returned: when Launch Configuration was found

Sample: []

user_data

string

User data used to start instance

Returned: when Launch Configuration was found

Sample: "ZXhwb3J0IENMT1VE"

Authors

  • Jose Armesto (@fiunchinho)