community.aws.autoscaling_launch_config_find module – Find AWS Autoscaling Launch Configurations
Note
This module is part of the community.aws collection (version 8.0.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.autoscaling_launch_config_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.
Prior to release 5.0.0 this module was called
community.aws.ec2_lc_find
. The usage did not change.
Aliases: ec2_lc_find
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
How many results to show. Corresponds to Python slice notation like list[:limit]. |
|
A Launch Configuration to match. It’ll be compiled as regex. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Order in which to sort results. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
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.autoscaling_launch_config_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 |
---|---|
Name of the AMI Returned: when Launch Configuration was found Sample: |
|
Assign public address or not Returned: when Launch Configuration was found Sample: |
|
Launch Configuration block device mappings property Returned: when Launch Configuration was found Sample: |
|
Launch Configuration classic link vpc security groups property Returned: when Launch Configuration was found Sample: |
|
When it was created Returned: when Launch Configuration was found Sample: |
|
Launch Configuration EBS optimized property Returned: when Launch Configuration was found Sample: |
|
AMI id Returned: when Launch Configuration was found Sample: |
|
Launch Configuration instance monitoring property Returned: when Launch Configuration was found Sample: |
|
Type of ec2 instance Returned: when Launch Configuration was found Sample: |
|
Launch Configuration kernel to use Returned: when Launch Configuration was found Sample: |
|
Launch Configuration ssh key Returned: when Launch Configuration was found Sample: |
|
Name of the Launch Configuration Returned: when Launch Configuration was found Sample: |
|
Launch Configuration ram disk property Returned: when Launch Configuration was found Sample: |
|
Launch Configuration security groups Returned: when Launch Configuration was found Sample: |
|
User data used to start instance Returned: when Launch Configuration was found Sample: |