ansible.builtin.ec2_lc_facts (v2.6.20) — module

Gather facts about AWS Autoscaling Launch Configurations

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

Authors: Loïc Latreille (@psykotox)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

Gather facts about AWS Autoscaling Launch Configurations


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.

# Gather facts about all launch configurations
- ec2_lc_facts:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather facts about launch configuration with name "example"
- ec2_lc_facts:
    name: example
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Gather facts sorted by created_time from most recent to least recent
- ec2_lc_facts:
    sort: created_time
    sort_order: descending

Inputs

    
name:
    default: []
    description:
    - A name or a list of name to match.

sort:
    choices:
    - launch_configuration_name
    - image_id
    - created_time
    - instance_type
    - kernel_id
    - ramdisk_id
    - key_name
    description:
    - Optional attribute which with to sort the results.

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    type: str

sort_end:
    description:
    - Which result to end with (when sorting).
    - Corresponds to Python slice notation.

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).
    type: dict

sort_order:
    choices:
    - ascending
    - descending
    default: ascending
    description:
    - Order in which to sort results.
    - Only used when the 'sort' parameter is specified.

sort_start:
    description:
    - Which result to start with (when sorting).
    - Corresponds to Python slice notation.

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_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

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - '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.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    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.
    - The I(aws_secret_key) and I(profile) options are mutually exclusive.
    type: str

security_token:
    aliases:
    - aws_session_token
    - session_token
    - 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.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
    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

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