ansible.builtin.ec2_lc_find (v2.9.17) — module

Find AWS Autoscaling Launch Configurations

| "added in version" 2.2 of ansible.builtin"

Authors: Jose Armesto (@fiunchinho)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Note: These examples do not set authentication details, see the AWS Guide for details.

# Search for the Launch Configurations that start with "app"
- ec2_lc_find:
    name_regex: app.*
    sort_order: descending
    limit: 2

Inputs

    
limit:
    description:
    - How many results to show.
    - Corresponds to Python slice notation like list[:limit].

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - The AWS region to use.
    required: true

ec2_url:
    aliases:
    - aws_endpoint_url
    - endpoint_url
    description:
    - 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.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
      and support for passing them at the same time as I(profile) has been deprecated.
    - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
      exclusive with I(profile) after 2022-06-01.
    type: str

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
      for more boto configuration.
    type: dict

name_regex:
    description:
    - A Launch Configuration to match
    - It'll be compiled as regex
    required: true

sort_order:
    choices:
    - ascending
    - descending
    default: ascending
    description:
    - Order in which to sort results.

aws_ca_bundle:
    description:
    - 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.'
    type: path

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
      or C(EC2_ACCESS_KEY) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
      or C(EC2_SECRET_KEY) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

security_token:
    aliases:
    - aws_security_token
    - access_token
    description:
    - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
      or C(EC2_SECURITY_TOKEN) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(security_token) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for communication with
      the AWS APIs.
    type: bool

debug_botocore_endpoint_logs:
    default: 'no'
    description:
    - 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.
    type: bool

Outputs

arn:
  description: Name of the AMI
  returned: when Launch Configuration was found
  sample: arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject
  type: str
associate_public_address:
  description: Assign public address or not
  returned: when Launch Configuration was found
  sample: true
  type: bool
block_device_mappings:
  description: Launch Configuration block device mappings property
  returned: when Launch Configuration was found
  sample: []
  type: list
classic_link_vpc_security_groups:
  description: Launch Configuration classic link vpc security groups property
  returned: when Launch Configuration was found
  sample: []
  type: list
created_time:
  description: When it was created
  returned: when Launch Configuration was found
  sample: '2016-06-29T14:59:22.222000+00:00'
  type: str
ebs_optimized:
  description: Launch Configuration EBS optimized property
  returned: when Launch Configuration was found
  sample: false
  type: bool
image_id:
  description: AMI id
  returned: when Launch Configuration was found
  sample: ami-0d75df7e
  type: str
instance_monitoring:
  description: Launch Configuration instance monitoring property
  returned: when Launch Configuration was found
  sample:
    Enabled: false
  type: str
instance_type:
  description: Type of ec2 instance
  returned: when Launch Configuration was found
  sample: t2.small
  type: str
kernel_id:
  description: Launch Configuration kernel to use
  returned: when Launch Configuration was found
  sample: ''
  type: str
keyname:
  description: Launch Configuration ssh key
  returned: when Launch Configuration was found
  sample: mykey
  type: str
name:
  description: Name of the Launch Configuration
  returned: when Launch Configuration was found
  sample: myapp-v123
  type: str
ram_disk_id:
  description: Launch Configuration ram disk property
  returned: when Launch Configuration was found
  sample: ''
  type: str
security_groups:
  description: Launch Configuration security groups
  returned: when Launch Configuration was found
  sample: []
  type: list
user_data:
  description: User data used to start instance
  returned: when Launch Configuration was found
  sample: ZXhwb3J0IENMT1VE
  type: str